> 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/product-information-management.md).

# Product Information Management

## Retrieve Product List

> \## Function Description\
> \* Searches the product list according to the product search conditions.\
> \---\
> \## Detailed Description\
> \* Searches the product list according to the product search conditions.\
> \* If a product number is entered among the search conditions, the product registration period condition is ignored.<br>

```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":{"GoodsMgmtApiRequest":{"type":"object","description":"Product Management API Request","properties":{"goodsDtmOption":{"type":"string","description":"Search Period Option"},"goodsDtmIgnoreOption":{"type":"string","description":"Ignore Search Period Option"},"goodsStartDtm":{"type":"string","format":"date-time","description":"Start Date"},"goodsEndDtm":{"type":"string","format":"date-time","description":"End Date"},"saleStatCd":{"type":"string","description":"Sales Status"},"soutCausCd":{"type":"string","description":"Out-of-Stock Reason"},"saleStatChgCausCd":{"type":"string","description":"Product Status Change Reason"},"mdId":{"type":"string","description":"MD No."},"mdNm":{"type":"string","description":"MD Name"},"goodsNm":{"type":"string","description":"Product Name"},"brandNo":{"type":"string","description":"Brand No."},"brandNm":{"type":"string","description":"Brand Name"},"entrNo":{"type":"string","description":"Vendor No."},"entrNm":{"type":"string","description":"Vendor Name"},"goodsNoOption":{"type":"string","description":"Product No. Option"},"goodsNoList":{"type":"string","description":"Product No. List String"},"goodsNoArray":{"type":"array","description":"Product No. List Array","items":{"type":"string"}},"goodsNoFrom":{"type":"string","description":"Product No. From Condition"},"goodsNoTo":{"type":"string","description":"Product No. To Condition"},"goodsNo":{"type":"string","description":"Product No."},"goodsCompCd":{"type":"string","description":"Product Composition"},"goodsTypCd":{"type":"string","description":"Product Type"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type"},"saleMethCd":{"type":"string","description":"Sales Method"},"buyTypCd":{"type":"string","description":"Purchase Type"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Type"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"stkMgrYn":{"type":"string","description":"Inventory Management Status"},"stdCtgNo":{"type":"string","description":"Standard Category"},"adveWrd":{"type":"string","description":"Promotional Text"},"adveUseYn":{"type":"string","description":"Promotional Text Usage Status"},"prestYn":{"type":"string","description":"Free Gift Status"},"searchDispCtgNo":{"type":"string","description":"Display Category"},"dispYn":{"type":"string","description":"Display Status"},"goodsImgYn":{"type":"string","description":"Image Included Status"},"optnYn":{"type":"string","description":"Use Option"},"gvgfPsbYn":{"type":"string","description":"Gifting Available Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Order Status"},"buyQtyLmtYn":{"type":"string","description":"Purchase Restriction Status"},"prcCompaExpYn":{"type":"string","description":"Price Comparison Status"},"searchSysModId":{"type":"string","description":"Modifier ID"},"milgRsrvPsbYn":{"type":"string","description":"Mileage Accrual Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}}},"ResponseRealGridListResponseGoodsMgmtApiResponse":{"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/RealGridListResponseGoodsMgmtApiResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseGoodsMgmtApiResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/GoodsMgmtApiResponse"}}}},"GoodsMgmtApiResponse":{"type":"object","description":"Product Management API Response","properties":{"goodsCompCd":{"type":"string","description":"Product Composition"},"goodsTypCd":{"type":"string","description":"Product Type"},"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"brandNo":{"type":"string","description":"Brand No."},"brandNm":{"type":"string","description":"Brand Name"},"modlNm":{"type":"string","description":"Model Name"},"saleStatCd":{"type":"string","description":"Sales Status Code"},"saleMethCd":{"type":"string","description":"Sales Method Code"},"taxGbCd":{"type":"string","description":"Tax/Tax-Exempt Classification Code"},"supPcost":{"type":"number","description":"Supply Price"},"norPrc":{"type":"number","description":"Regular Price"},"salePrc":{"type":"number","description":"Selling Price"},"mrgnRate":{"type":"number","description":"Margin Rate"},"prcCompaExpYn":{"type":"string","description":"Price Comparison Status"},"dispYn":{"type":"string","description":"Display Status"},"safeStkNotiYn":{"type":"string","description":"Safety Stock Alert Status"},"stdCtgHierarchy":{"type":"string","description":"Standard Classification Hierarchy Structure"},"mdId":{"type":"string","description":"MD Name"},"entrNm":{"type":"string","description":"Vendor Name"},"saleStrDtm":{"type":"string","format":"date-time","description":"Sales Start Date/Time"},"saleEndDtm":{"type":"string","format":"date-time","description":"Sales End Date/Time"},"adveWrd":{"type":"string","description":"Promotional Text"},"lgcGoodsNo":{"type":"string","description":"Internal Product No."},"goodsRepImgPathNm":{"type":"string","description":"Product Main Image"},"buyTypCd":{"type":"string","description":"Contract Type"},"buyQtyLmtYn":{"type":"string","description":"Purchase Restriction"},"stkMgrYn":{"type":"string","description":"Inventory Management Status"},"optnYn":{"type":"string","description":"Option Usage Status"},"milgRsrvPsbYn":{"type":"string","description":"Mileage Accrual Status"},"gvgfPsbYn":{"type":"string","description":"Gift-Eligible Status"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"prestYn":{"type":"string","description":"Free Gift Status"},"deliGoodsGbNm":{"type":"string","description":"Delivery Product Type"},"deliProcTypNm":{"type":"string","description":"Delivery Processing Type"},"buyTypNm":{"type":"string","description":"Contract Type"},"timeDealYn":{"type":"string","description":"Time Deal Application Status"},"tmdlHistStrDtm":{"type":"string","format":"date-time","description":"Time Deal Start Date/Time"},"tmdlHistEndDtm":{"type":"string","format":"date-time","description":"Time Deal End Date/Time"},"tmdlSalePrc":{"type":"number","description":"Time Deal Selling Price"},"frgnDirPurGoodsYn":{"type":"string","description":"Overseas Direct Purchase Product Status"}}},"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":{"/v2/goods/goodsMgmtApi/getGoodsList":{"get":{"tags":["Product Information Management"],"summary":"Retrieve Product List","description":"## Function Description\n* Searches the product list according to the product search conditions.\n---\n## Detailed Description\n* Searches the product list according to the product search conditions.\n* If a product number is entered among the search conditions, the product registration period condition is ignored.\n","operationId":"getGoodsList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsMgmtApiRequest"}}],"responses":{"200":{"description":"Product List Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseGoodsMgmtApiResponse"}}}},"900":{"description":"Product List Retrieval Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```