> 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/popup-bo-api/product-management-common-popup.md). # Product Management Common Popup ## Bulk Change Sales Status > \## Function Description\ > \* Bulk changes the sales status of products or SKUs.\ > \---\ > \## Detailed Description\ > \* Bulk changes the sales status of products or SKUs.\ > \* When bulk changing the sales status of a product, enter only the product number and leave the SKU number blank.\ > \* When bulk changing a product's sales status, the status of all SKUs of that product is also changed in bulk.\ > \* When changing from On Sale -> Sold Out, only SKUs currently on sale are changed to sold out.\ > \* When changing from Sold Out -> On Sale, all sold-out SKUs whose sales status has not been separately changed are changed to on sale.\ > \* When changed to On Sale, SKUs with no stock are automatically changed to sold out when the sold-out batch runs.\ > \* When bulk changing the sales status of an SKU, enter both the product number and the SKU number.\ > \* When bulk changing SKU sales status, if the sales status of all SKUs changes, the product's sales status is also changed accordingly.
```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":[]}],"paths":{"/v2/popup/goodsMgmtPopupApi/modifyGoodsSaleState":{"post":{"tags":["Product Management Common Popup"],"summary":"Bulk Change Sales Status","description":"## Function Description\n* Bulk changes the sales status of products or SKUs.\n---\n## Detailed Description\n* Bulk changes the sales status of products or SKUs.\n* When bulk changing the sales status of a product, enter only the product number and leave the SKU number blank.\n * When bulk changing a product's sales status, the status of all SKUs of that product is also changed in bulk.\n * When changing from On Sale -> Sold Out, only SKUs currently on sale are changed to sold out.\n * When changing from Sold Out -> On Sale, all sold-out SKUs whose sales status has not been separately changed are changed to on sale.\n * When changed to On Sale, SKUs with no stock are automatically changed to sold out when the sold-out batch runs.\n* When bulk changing the sales status of an SKU, enter both the product number and the SKU number.\n * When bulk changing SKU sales status, if the sales status of all SKUs changes, the product's sales status is also changed accordingly.\n","operationId":"modifyGoodsSaleState","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoodsSaleStatePopupApiRequest"}}},"required":true},"responses":{"200":{"description":"Bulk Sales Status Change Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Bulk Sales Status Change Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"GoodsSaleStatePopupApiRequest":{"type":"object","properties":{"goodsSaleStateRequest":{"type":"string"},"goodsSaleStateList":{"type":"array","description":"Product Sales Status Information DTO List","items":{"$ref":"#/components/schemas/GoodsSaleStateDto"}}}},"GoodsSaleStateDto":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"saleStatCd":{"type":"string","description":"Sales Status"},"soutCausCd":{"type":"string","description":"Out-of-Stock Reason Code"},"saleStatChgCausCd":{"type":"string","description":"Sales Status Change Reason Code"},"itmNo":{"type":"string","description":"Item No."},"itmSaleStatCd":{"type":"string","description":"SKU Sales Status Code"},"soutNotiYn":{"type":"string","description":"Item Sold-Out Alert Status"},"soutNotiStdQty":{"type":"string","description":"Sold-Out Alert Threshold Quantity"}}},"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"}}}}}} ``` ## Retrieve Product List > \## Function Description\ > \* Retrieves the product list.\ > \---\ > \## Detailed Description\ > \* Retrieves the product list according to the search conditions.\ > \* If a product number is entered, the entire period is searched, ignoring the product registration period condition.\ > \---\ > \## Revision History\ > \`\`\`Release v1.04\_231120\`\`\`\ > \- Added bundle product addition validation process\ > \- Added Purchase Quantity Limit Status (buyQtyLmtYn), Minimum Limit Quantity (minLmtQty), Maximum Limit Quantity (maxLmtQty) to response\ > \ > \`\`\`Release v1.05\_231204\`\`\`\ > \- Added Regular Delivery Product Status (rglrDeliGoodsYn) to search conditions\ > \ > \`\`\`Release v1.06\_250609\`\`\`\ > \- Added time deal information inquiry
````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":[]}],"paths":{"/v2/popup/goodsMgmtPopupApi/getGoodsList":{"get":{"tags":["Product Management Common Popup"],"summary":"Retrieve Product List","description":"## Function Description\n* Retrieves the product list.\n---\n## Detailed Description\n* Retrieves the product list according to the search conditions.\n* If a product number is entered, the entire period is searched, ignoring the product registration period condition.\n---\n## Revision History\n```Release v1.04_231120```\n - Added bundle product addition validation process\n - Added Purchase Quantity Limit Status (buyQtyLmtYn), Minimum Limit Quantity (minLmtQty), Maximum Limit Quantity (maxLmtQty) to response\n\n```Release v1.05_231204```\n - Added Regular Delivery Product Status (rglrDeliGoodsYn) to search conditions\n\n```Release v1.06_250609```\n - Added time deal information inquiry\n","operationId":"getGoodsList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsListPopupApiRequest"}}],"responses":{"200":{"description":"Product List Retrieved Successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseGoodsListPopupApiResponse"}}}},"900":{"description":"Product List Retrieval Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}},"components":{"schemas":{"GoodsListPopupApiRequest":{"type":"object","properties":{"goodsDtmIgnoreOption":{"type":"boolean","description":"Ignore Search Period Option"},"goodsDtmOption":{"type":"string","description":"Search Period Option"},"goodsRegStartDtm":{"type":"string","format":"date-time","description":"Product Registration Start Date"},"goodsRegEndDtm":{"type":"string","format":"date-time","description":"Product Registration End Date"},"mdId":{"type":"string","description":"Assigned MD ID"},"entrNo":{"type":"string","description":"Vendor No."},"brandNo":{"type":"string","description":"Brand No."},"stdCtgNo":{"type":"string","description":"Standard Classification Category No."},"saleStatCd":{"type":"string","description":"Sales Status Code"},"saleStatCdList":{"type":"array","description":"Sales Status Code List","items":{"type":"string"}},"goodsCompCd":{"type":"string","description":"Product Composition Code"},"goodsTypCd":{"type":"string","description":"Product Type Code"},"saleMethCd":{"type":"string","description":"Sales Method Code"},"buyTypCd":{"type":"string","description":"Purchase Type Code"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type Mode"},"goodsNm":{"type":"string","description":"Product Name"},"goodsNo":{"type":"string","description":"Product No."},"dispCtgNo":{"type":"string","description":"Display Category No."},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Status"},"frgnDirPurGoodsYn":{"type":"string","description":"Direct Purchase Product Status"},"searchCodeOption":{"type":"string","description":"Product No. Option (st: Starts With, in: Contains, eq: Equals, mt: Multiple, rg: Range)"},"searchCodeFrom":{"type":"string","description":"Product No. Start Condition"},"searchCodeTo":{"type":"string","description":"Product No. End Condition"},"searchCode":{"type":"string","description":"Product No."},"searchCodeText":{"type":"string","description":"Product No. Search Term"},"searchCodeTextList":{"type":"array","description":"Product No. Search Term (Multiple)","items":{"type":"string"}}}},"ResponseRealGridListResponseGoodsListPopupApiResponse":{"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/RealGridListResponseGoodsListPopupApiResponse","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseGoodsListPopupApiResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/GoodsListPopupApiResponse"}}}},"GoodsListPopupApiResponse":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"goodsNm":{"type":"string","description":"Product Name"},"goodsCompCd":{"type":"string","description":"Product Composition Code"},"goodsTypCd":{"type":"string","description":"Product Type Code"},"entrNm":{"type":"string","description":"Vendor Name"},"entrNo":{"type":"string","description":"Vendor No."},"brandNm":{"type":"string","description":"Brand Name"},"saleMethCd":{"type":"string","description":"Sales Method Code"},"saleStatCd":{"type":"string","description":"Sales Status Code"},"saleStatCdNm":{"type":"string","description":"Sales Status Code Name"},"buyTypCd":{"type":"string","description":"Purchase Type Code"},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type Code"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Type"},"deliWayCd":{"type":"string","description":"Delivery Method Code"},"goodsRegDtm":{"type":"string","format":"date-time","description":"Product Registration Date/Time"},"mdNm":{"type":"string","description":"MD in Charge Name"},"dispYn":{"type":"string","description":"Display Status"},"deliProcTypCdNm":{"type":"string","description":"Delivery Processing Type Name"},"deliGoodsGbCdNm":{"type":"string","description":"Delivery Product Classification Code Name"},"salePrc":{"type":"number","description":"Selling Price"},"dispDlexAmt":{"type":"string","description":"Delivery Fee"},"stdCtgHierarchy":{"type":"string","description":"Standard Category"},"buyrAgeLmtCd":{"type":"string","description":"Buyer Age Restriction Code"},"buyQtyLmtYn":{"type":"string","description":"Purchase Quantity Limit Status"},"minLmtQty":{"type":"integer","format":"int32","description":"Minimum Limit Quantity"},"maxLmtQty":{"type":"integer","format":"int32","description":"Maximum Limit Quantity"},"stkQty":{"type":"integer","format":"int32","description":"Stock Quantity"},"mileagePayYn":{"type":"string","description":"Mileage Payment Available Status"},"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"},"rsvStrtDtm":{"type":"string","description":"Reservation Start Date/Time (YYYYMMDDHH24MISS)"},"rsvEndDtm":{"type":"string","description":"Reservation End Date/Time (YYYYMMDDHH24MISS)"},"rglrDeliGoodsYn":{"type":"string","description":"Subscription Delivery Product Status"},"frgnDirPurGoodsYn":{"type":"string","description":"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"}}}}}} ````