> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/goods-bo-api/option-information-management.md).
# Option Information Management
## Save Option Code List
> \## 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)
````json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestPrOptnCd":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrOptnCd"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrOptnCd"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrOptnCd"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrOptnCd"}}}},"PrOptnCd":{"type":"object","description":"Option Code","properties":{"optnCatNo":{"type":"string","default":"1000","description":"Option Classification No."},"optnNo":{"type":"string","default":"001","description":"Option No."},"optnNm":{"type":"string","default":"옵션명","description":"Option Name"},"sortSeq":{"type":"integer","format":"int32","default":1,"description":"Sort Order"},"useYn":{"type":"string","default":"Y","description":"Usage Status"},"imgPathNm":{"type":"string","description":"Image Path"},"imgFileNm":{"type":"string","description":"Image File Name"},"rgbVal":{"type":"string","description":"RGB Value"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/optionMgmtApi/saveOptionList":{"post":{"tags":["Option Information Management"],"summary":"Save Option Code List","description":"## Function Description\n* An API for saving the option code list.\n---\n## Detailed Description\n* Saves the option code information list.\n---\n## Notes\n* When the option name is modified, the option name in the unit option information is also modified.\n---\n## Validation\n* Validates the option code information when saving.\n * Required input: option name, sort order, usage status, option category number, system registrant ID\n---\n## Revision History\n```Release v1.03_231106```: Added a new feature to add images and register RGB values in the option code list within Option Information Management,\nadded variables image path name (imgPathNm), image file name (imgFileNm), RGB value (rgbVal)\n","operationId":"saveOptionList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestPrOptnCd"}}},"required":true},"responses":{"200":{"description":"Save Option Code List Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Save Option Code List Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````
## Save Option Category Code List
> \## 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')
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"RealGridCUDRequestPrOptnClssCd":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/PrOptnClssCd"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/PrOptnClssCd"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/PrOptnClssCd"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/PrOptnClssCd"}}}},"PrOptnClssCd":{"type":"object","description":"Option Category Code","properties":{"optnCatNo":{"type":"string","default":"1000","description":"Option Classification No."},"optnCatNm":{"type":"string","default":"옵션분류명","description":"Option Classification Name"},"optnCatRegGbCd":{"type":"string","default":"01","description":"Option Classification Registration Type Code (PR018) 01: Common, 02: Vendor-Exclusive"},"entrNo":{"type":"string","default":"1000001","description":"Vendor No."},"optnCatTypCd":{"type":"string","default":"10","description":"Option Classification Type Code (PR019) 10: Color, 11: Size, 12: Weight, 13: Capacity, 14: Region, 15: Clothing Size, 17: Monitor Type, 18: Monitor Size, 19: Monitor Resolution, 20: Camera Color, 21: Camera Resolution, 22: Food Weight, 23: Food Capacity"},"sortSeq":{"type":"integer","format":"int32","default":1,"description":"Sort Order"},"useYn":{"type":"string","default":"Y","description":"Usage Status"}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/optionMgmtApi/saveOptionCategoryList":{"post":{"tags":["Option Information Management"],"summary":"Save Option Category Code List","description":"## Function Description\n* An API for saving the option category code list.\n---\n## Detailed Description\n* Saves the option category code information list.\n---\n## Notes\n* When the option category name is modified, the option category name in the unit option information is also modified.\n---\n## Validation\n* Validates the option category code information when saving.\n * 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')\n* The option category name cannot be duplicated.\n * 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')\n","operationId":"saveOptionCategoryList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestPrOptnClssCd"}}},"required":true},"responses":{"200":{"description":"Save Option Category Code List Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Save Option Category Code List Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Save Manually Entered Option Master
> \## 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.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SaveCustomOptionRequest":{"type":"object","description":"Save Manually Entered Option Master Request","properties":{"langCd":{"type":"string","default":"ko","description":"Language Code"},"optnCatRegGbCd":{"type":"string","description":"Option Category Registration Type Code (PR018) — 01: Common (BO), 02: Vendor-only (PO)"},"entrNo":{"type":"string","description":"Vendor No. — required when optnCatRegGbCd='02' (Vendor-only)"},"optnCatTypCd":{"type":"string","description":"Option Classification Type Code (PR019)"},"optnCatNm":{"type":"string","description":"Option Classification Name"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order (default 0)"},"optnList":{"type":"array","description":"Option Value List","items":{"$ref":"#/components/schemas/OptnItem"}}},"required":["optnCatNm","optnCatRegGbCd","optnCatTypCd","optnList"]},"OptnItem":{"type":"object","properties":{"optnNm":{"type":"string","description":"Option Name"}}},"ResponseSaveCustomOptionResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/SaveCustomOptionResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"SaveCustomOptionResponse":{"type":"object","description":"Save Manually Entered Option Master Response","properties":{"optnCatNo":{"type":"string","description":"New Option Category No."},"optnList":{"type":"array","description":"Saved Option Value List","items":{"$ref":"#/components/schemas/OptnResultItem"}}}},"OptnResultItem":{"type":"object","properties":{"optnNo":{"type":"string","description":"Option No."},"optnNm":{"type":"string","description":"Option Name"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/optionMgmtApi/saveCustomOption":{"post":{"tags":["Option Information Management"],"summary":"Save Manually Entered Option Master","description":"## Function Description\n* Permanently registers options manually entered in the option information grid into the vendor master (PR_OPTN_CLSS_CD / PR_OPTN_CD).\n---\n## Detailed Description\n* Inserts a new category code with optnCatRegGbCd='02' (vendor-only), using the specified entrNo / optnCatTypCd.\n* Replaces the grid's sentinel ID with the optnCatNo / optnNo from the response, so subsequent saves are processed via the master-linked path.\n","operationId":"saveCustomOption","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SaveCustomOptionRequest"}}},"required":true},"responses":{"200":{"description":"Save Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseSaveCustomOptionResponse"}}}},"900":{"description":"Save Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Search Option Code List
> \## 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.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseRealGridListResponseOptionMgmtApiResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/RealGridListResponseOptionMgmtApiResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseOptionMgmtApiResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OptionMgmtApiResponse"}}}},"OptionMgmtApiResponse":{"type":"object","description":"Option Management API Response","properties":{"langCd":{"type":"string","description":"Language Code (CM009)"},"optnCatNo":{"type":"string","description":"Option Classification No."},"optnCatRegGbCd":{"type":"string","description":"Option Classification Registration Type Code (PR018) 01: Common, 02: Vendor-Exclusive"},"entrNo":{"type":"string","description":"Vendor No."},"optnCatTypCd":{"type":"string","description":"Option Classification Type Code (PR019) 10: Color, 11: Size, 12: Weight, 13: Capacity, 14: Region, 15: Clothing Size, 17: Monitor Type, 18: Monitor Size, 19: Monitor Resolution, 20: Camera Color, 21: Camera Resolution, 22: Food Weight, 23: Food Capacity"},"optnCatNm":{"type":"string","description":"Option Classification Name"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"useYn":{"type":"string","description":"Usage Status"},"optnCatRegGbCdNm":{"type":"string","description":"Option Classification Registration Type Code Name"},"optnCatTypCdNm":{"type":"string","description":"Option Classification Type Code Name"},"entrNm":{"type":"string","description":"Vendor Name"},"optnNo":{"type":"string","description":"Option No."},"optnNm":{"type":"string","description":"Option Name"},"addOptnNm":{"type":"string","description":"Additional Option Name"},"imgPathNm":{"type":"string","description":"Image Path"},"imgFileNm":{"type":"string","description":"Image File Name"},"rgbVal":{"type":"string","description":"RGB Value"},"totalCount":{"type":"integer","format":"int32"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/optionMgmtApi/getOptionList":{"get":{"tags":["Option Information Management"],"summary":"Search Option Code List","description":"## Function Description\n* An API for searching the option code list.\n---\n## Detailed Description\n* Searches the option code information list based on the option category number.\n * Sorted by sort order in ascending order, then by modification date/time in descending order.\n","operationId":"getOptionList","parameters":[{"name":"langCd","in":"query","description":"Language Code","schema":{"type":"string"}},{"name":"optnCatNo","in":"query","description":"Option Classification No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Search Option Code List Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseOptionMgmtApiResponse"}}}},"900":{"description":"Search Option Code List Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Search Option Category Code List
> \## 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.
```json
{"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"OptionMgmtApiRequest":{"type":"object","description":"Option Management Request","properties":{"condxOptnCatTypCd":{"type":"string","default":"10","description":"Option Classification Type Code (PR019) 10: Color, 11: Size, 12: Weight, 13: Capacity, 14: Region, 15: Clothing Size, 17: Monitor Type, 18: Monitor Size, 19: Monitor Resolution, 20: Camera Color, 21: Camera Resolution, 22: Food Weight, 23: Food Capacity"},"condxOptnCatRegGbCd":{"type":"string","default":"01","description":"Option Classification Registration Type Code (PR018)"},"condxUseYn":{"type":"string","default":"Y","description":"Option Classification Code Usage Status"},"optnCatNo":{"type":"string","default":"1000","description":"Option Classification No."},"entrNo":{"type":"string","default":"1000001","description":"Vendor No."},"useYn":{"type":"string","default":"Y","description":"Option Code Usage Status"}}},"ResponseRealGridListResponseOptionMgmtApiResponse":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/RealGridListResponseOptionMgmtApiResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseOptionMgmtApiResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/OptionMgmtApiResponse"}}}},"OptionMgmtApiResponse":{"type":"object","description":"Option Management API Response","properties":{"langCd":{"type":"string","description":"Language Code (CM009)"},"optnCatNo":{"type":"string","description":"Option Classification No."},"optnCatRegGbCd":{"type":"string","description":"Option Classification Registration Type Code (PR018) 01: Common, 02: Vendor-Exclusive"},"entrNo":{"type":"string","description":"Vendor No."},"optnCatTypCd":{"type":"string","description":"Option Classification Type Code (PR019) 10: Color, 11: Size, 12: Weight, 13: Capacity, 14: Region, 15: Clothing Size, 17: Monitor Type, 18: Monitor Size, 19: Monitor Resolution, 20: Camera Color, 21: Camera Resolution, 22: Food Weight, 23: Food Capacity"},"optnCatNm":{"type":"string","description":"Option Classification Name"},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"},"useYn":{"type":"string","description":"Usage Status"},"optnCatRegGbCdNm":{"type":"string","description":"Option Classification Registration Type Code Name"},"optnCatTypCdNm":{"type":"string","description":"Option Classification Type Code Name"},"entrNm":{"type":"string","description":"Vendor Name"},"optnNo":{"type":"string","description":"Option No."},"optnNm":{"type":"string","description":"Option Name"},"addOptnNm":{"type":"string","description":"Additional Option Name"},"imgPathNm":{"type":"string","description":"Image Path"},"imgFileNm":{"type":"string","description":"Image File Name"},"rgbVal":{"type":"string","description":"RGB Value"},"totalCount":{"type":"integer","format":"int32"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/goods/optionMgmtApi/getOptionCategoryList":{"get":{"tags":["Option Information Management"],"summary":"Search Option Category Code List","description":"## Function Description\n* An API for searching the option category code list.\n---\n## Detailed Description\n* Searches the option category code information list.\n * Sorted by sort order in ascending order, then by modification date/time in descending order.\n","operationId":"getOptionCategoryList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OptionMgmtApiRequest"}}],"responses":{"200":{"description":"Search Option Category Code List Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseOptionMgmtApiResponse"}}}},"900":{"description":"Search Option Category Code List Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```