Ctrlk
X2BEE Home
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Option Information Management

Save Option Code List

post

Function Description

  • An API for saving the option code list.

Detailed Description

  • Saves the option code information list.

Notes

  • When the option name is modified, the option name in the unit option information is also modified.

Validation

  • Validates the option code information when saving.

    • Required input: option name, sort order, usage status, option category number, system registrant ID

Revision History

Release v1.03_231106: Added a new feature to add images and register RGB values in the option code list within Option Information Management, added variables image path name (imgPathNm), image file name (imgFileNm), RGB value (rgbVal)

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Save Option Code List Success

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v1/goods/optionMgmtApi/saveOptionList
POST /api/bo/v1/goods/optionMgmtApi/saveOptionList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 582

{
  "all": [
    {
      "optnCatNo": "1000",
      "optnNo": "001",
      "optnNm": "옵션명",
      "sortSeq": 1,
      "useYn": "Y",
      "imgPathNm": "text",
      "imgFileNm": "text",
      "rgbVal": "text"
    }
  ],
  "create": [
    {
      "optnCatNo": "1000",
      "optnNo": "001",
      "optnNm": "옵션명",
      "sortSeq": 1,
      "useYn": "Y",
      "imgPathNm": "text",
      "imgFileNm": "text",
      "rgbVal": "text"
    }
  ],
  "update": [
    {
      "optnCatNo": "1000",
      "optnNo": "001",
      "optnNm": "옵션명",
      "sortSeq": 1,
      "useYn": "Y",
      "imgPathNm": "text",
      "imgFileNm": "text",
      "rgbVal": "text"
    }
  ],
  "delete": [
    {
      "optnCatNo": "1000",
      "optnNo": "001",
      "optnNm": "옵션명",
      "sortSeq": 1,
      "useYn": "Y",
      "imgPathNm": "text",
      "imgFileNm": "text",
      "rgbVal": "text"
    }
  ]
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Save Option Category Code List

post

Function Description

  • An API for saving the option category code list.

Detailed Description

  • Saves the option category code information list.

Notes

  • When the option category name is modified, the option category name in the unit option information is also modified.

Validation

  • Validates the option category code information when saving.

    • Required input: option category registration type code, option category type, option category name, sort order, usage status, system registrant ID, vendor number (when the option category registration type code is 'Vendor-only')

  • The option category name cannot be duplicated.

    • Duplicate check basis: option category registration type code, option category type code, option category name, vendor number (when the option category registration type code is 'Vendor-only')

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
Responses
200

Save Option Category Code List Success

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v1/goods/optionMgmtApi/saveOptionCategoryList
POST /api/bo/v1/goods/optionMgmtApi/saveOptionCategoryList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 586

{
  "all": [
    {
      "optnCatNo": "1000",
      "optnCatNm": "옵션분류명",
      "optnCatRegGbCd": "01",
      "entrNo": "1000001",
      "optnCatTypCd": "10",
      "sortSeq": 1,
      "useYn": "Y"
    }
  ],
  "create": [
    {
      "optnCatNo": "1000",
      "optnCatNm": "옵션분류명",
      "optnCatRegGbCd": "01",
      "entrNo": "1000001",
      "optnCatTypCd": "10",
      "sortSeq": 1,
      "useYn": "Y"
    }
  ],
  "update": [
    {
      "optnCatNo": "1000",
      "optnCatNm": "옵션분류명",
      "optnCatRegGbCd": "01",
      "entrNo": "1000001",
      "optnCatTypCd": "10",
      "sortSeq": 1,
      "useYn": "Y"
    }
  ],
  "delete": [
    {
      "optnCatNo": "1000",
      "optnCatNm": "옵션분류명",
      "optnCatRegGbCd": "01",
      "entrNo": "1000001",
      "optnCatTypCd": "10",
      "sortSeq": 1,
      "useYn": "Y"
    }
  ]
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Save Manually Entered Option Master

post

Function Description

  • Permanently registers options manually entered in the option information grid into the vendor master (PR_OPTN_CLSS_CD / PR_OPTN_CD).

Detailed Description

  • Inserts a new category code with optnCatRegGbCd='02' (vendor-only), using the specified entrNo / optnCatTypCd.

  • Replaces the grid's sentinel ID with the optnCatNo / optnNo from the response, so subsequent saves are processed via the master-linked path.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Save Manually Entered Option Master Request

langCdstringOptional

Language Code

Default: ko
optnCatRegGbCdstringRequired

Option Category Registration Type Code (PR018) — 01: Common (BO), 02: Vendor-only (PO)

entrNostringOptional

Vendor No. — required when optnCatRegGbCd='02' (Vendor-only)

optnCatTypCdstringRequired

Option Classification Type Code (PR019)

optnCatNmstringRequired

Option Classification Name

sortSeqinteger · int32Optional

Sort Order (default 0)

Responses
200

Save Success

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

post/v1/goods/optionMgmtApi/saveCustomOption
POST /api/bo/v1/goods/optionMgmtApi/saveCustomOption HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "langCd": "ko",
  "optnCatRegGbCd": "text",
  "entrNo": "text",
  "optnCatTypCd": "text",
  "optnCatNm": "text",
  "sortSeq": 1,
  "optnList": [
    {
      "optnNm": "text"
    }
  ]
}
{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "optnCatNo": "text",
    "optnList": [
      {
        "optnNo": "text",
        "optnNm": "text"
      }
    ]
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Search Option Code List

get

Function Description

  • An API for searching the option code list.

Detailed Description

  • Searches the option code information list based on the option category number.

    • Sorted by sort order in ascending order, then by modification date/time in descending order.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
langCdstringOptional

Language Code

optnCatNostringRequired

Option Classification No.

Responses
200

Search Option Code List Success

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v1/goods/optionMgmtApi/getOptionList
GET /api/bo/v1/goods/optionMgmtApi/getOptionList?optnCatNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "totalCount": 1,
    "payloads": [
      {
        "langCd": "text",
        "optnCatNo": "text",
        "optnCatRegGbCd": "text",
        "entrNo": "text",
        "optnCatTypCd": "text",
        "optnCatNm": "text",
        "sortSeq": 1,
        "useYn": "text",
        "optnCatRegGbCdNm": "text",
        "optnCatTypCdNm": "text",
        "entrNm": "text",
        "optnNo": "text",
        "optnNm": "text",
        "addOptnNm": "text",
        "imgPathNm": "text",
        "imgFileNm": "text",
        "rgbVal": "text",
        "totalCount": 1
      }
    ]
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Search Option Category Code List

get

Function Description

  • An API for searching the option category code list.

Detailed Description

  • Searches the option category code information list.

    • Sorted by sort order in ascending order, then by modification date/time in descending order.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
Responses
200

Search Option Category Code List Success

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v1/goods/optionMgmtApi/getOptionCategoryList
GET /api/bo/v1/goods/optionMgmtApi/getOptionCategoryList?request=[object+Object] HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "totalCount": 1,
    "payloads": [
      {
        "langCd": "text",
        "optnCatNo": "text",
        "optnCatRegGbCd": "text",
        "entrNo": "text",
        "optnCatTypCd": "text",
        "optnCatNm": "text",
        "sortSeq": 1,
        "useYn": "text",
        "optnCatRegGbCdNm": "text",
        "optnCatTypCdNm": "text",
        "entrNm": "text",
        "optnNo": "text",
        "optnNm": "text",
        "addOptnNm": "text",
        "imgPathNm": "text",
        "imgFileNm": "text",
        "rgbVal": "text",
        "totalCount": 1
      }
    ]
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}
PreviousReserved Product Management
NextProduct Temporary Save Management