> 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/store-front-api-reference/goods-api/product-detail-delivery-information.md). # Product Detail Delivery Information ## Process Item Option Out-of-Stock Due to Loss Processing > \## Function Description\ > \* Processes an item option as out of stock due to loss processing\ > \---\ > \## Detailed Description\ > \* When registering a loss and the loss reason is insufficient stock, sets the sales status of the product item to out of stock\ > \* When releasing a loss, changes the sales status according to the stock status. .
```json {"openapi":"3.1.0","info":{"title":"X2BEE Goods API","version":"v1"},"servers":[{"url":"https://api-goods.x2bee.com/api/goods/","description":"prd"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"PrItmInsuffReq":{"type":"object","description":"Product Detail Inquiry Request DTO","properties":{"targetOrdDtlStatCd":{"type":"string","description":"Loss Processing Type 22: Loss Release, 23: Loss Registration"},"prItms":{"type":"array","items":{"$ref":"#/components/schemas/PrItm"}}}},"PrItm":{"type":"object","properties":{"goodsNo":{"type":"string","description":"Product No."},"itmNo":{"type":"string","description":"Item No."},"itmSaleStatCd":{"type":"string","description":"Item Sales Status Code (PR005) 01: Temporary Save, 02: Pending Approval, 03: Rejected, 10: On Sale, 20: Sold Out, 40: Discontinued"},"soutCausCd":{"type":"string","description":"Out-of-Stock Reason Code (PR032) 10: Auto Out-of-Stock Due to Shipping Unavailable, 11: Out-of-Stock Due to Zero Inventory, 12: Manual Out-of-Stock by Admin"},"userId":{"type":"string","description":"User ID"}}}}},"paths":{"/v1/delivery/updatePrItmStockByInsuff":{"post":{"tags":["Product Detail Delivery Information"],"summary":"Process Item Option Out-of-Stock Due to Loss Processing","description":"## Function Description\n* Processes an item option as out of stock due to loss processing\n---\n## Detailed Description\n* When registering a loss and the loss reason is insufficient stock, sets the sales status of the product item to out of stock\n* When releasing a loss, changes the sales status according to the stock status. .\n","operationId":"updatePrItmStockByInsuff","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrItmInsuffReq"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"object"}}}}}}}}} ``` ## Retrieve Delivery Fee by Delivery Policy No. > \## Function Description\ > \* This is the basic delivery fee policy API based on partner + delivery fee policy number.\ > \---\ > \## Detailed Description\ > \* Retrieves the list of basic delivery policy information using an array of partner + delivery fee policy number values.\ > \* Retrieves delivery policies whose basic usage status is Y.\ > \---\ > \## Revision History\ > \`\`\`Release v1.05\_231204\`\`\` : Added transaction type code (VD002)\ > \ > \`\`\`Release v2.00\_240627\`\`\` : Added additional delivery fee information
````json {"openapi":"3.1.0","info":{"title":"X2BEE Goods API","version":"v1"},"servers":[{"url":"https://api-goods.x2bee.com/api/goods/","description":"prd"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"EtDeliPolcBaseRequest":{"type":"object","description":"Delivery Policy Basic Request","properties":{"langCd":{"type":"string","default":"ko","description":"Language Code (CM009)"},"siteNo":{"type":"string","default":"1","description":"Site No."},"entrNo":{"type":"string","default":"10000001","description":"Vendor No."},"deliPolcNo":{"type":"string","default":"10000271","description":"Delivery Policy No."}}},"EtDeliPolcBaseResponse":{"type":"object","description":"Delivery Policy Basic Response","properties":{"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"entrNo":{"type":"string","description":"Vendor No."},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)"},"dlexTypCdNm":{"type":"string","description":"Delivery Fee Type Code Name"},"stdAmt":{"type":"integer","format":"int64","description":"Standard Amount"},"dlexAmt":{"type":"integer","format":"int64","description":"Delivery Fee Amount"},"wthdRtnAmt":{"type":"integer","format":"int64","description":"Return Pickup Fee"},"exchDlex":{"type":"integer","format":"int64","description":"Exchange Delivery Fee"},"addDlexInfoList":{"type":"array","description":"Additional Delivery Fee","items":{"$ref":"#/components/schemas/EtAddDlexInfoResponse"}},"useYn":{"type":"string","description":"Usage Status"},"trdTypCd":{"type":"string","description":"Transaction Type Code (VD002)"}}},"EtAddDlexInfoResponse":{"type":"object","description":"Additional Delivery Fee Information Response","properties":{"deliRegnGrpNo":{"type":"string","description":"Delivery Area Group No."},"deliRegnGrpNm":{"type":"string","description":"Delivery Area Group Name"},"addDlexAmt":{"type":"integer","format":"int64","description":"Additional Delivery Fee"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/delivery/deliProcInfo":{"post":{"tags":["Product Detail Delivery Information"],"summary":"Retrieve Delivery Fee by Delivery Policy No.","description":"## Function Description\n* This is the basic delivery fee policy API based on partner + delivery fee policy number.\n---\n## Detailed Description\n* Retrieves the list of basic delivery policy information using an array of partner + delivery fee policy number values.\n * Retrieves delivery policies whose basic usage status is Y.\n---\n## Revision History\n```Release v1.05_231204``` : Added transaction type code (VD002)\n\n```Release v2.00_240627``` : Added additional delivery fee information\n","operationId":"getDeliProcInfo","parameters":[{"name":"Authorization","in":"header","description":"Access Token","required":false}],"requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EtDeliPolcBaseRequest"}}}},"required":true},"responses":{"200":{"description":"Delivery Fee Policy Inquiry Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EtDeliPolcBaseResponse"}}}},"900":{"description":"Delivery Fee Policy Inquiry Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ```` ## Retrieve Delivery/Exchange/Return Info by Partner > \## Function Description\ > \* This API retrieves return/exchange information.\ > \---\ > \## Detailed Description\ > \* Retrieves the list of basic delivery policy information using the partner number value.\ > \* Retrieves delivery policies whose basic usage status is Y.
```json {"openapi":"3.1.0","info":{"title":"X2BEE Goods API","version":"v1"},"servers":[{"url":"https://api-goods.x2bee.com/api/goods/","description":"prd"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReturnOrChangeInfo":{"type":"object","description":"Return/Exchange Info","properties":{"langCd":{"type":"string","default":"ko","description":"Language Code (CM009)"},"siteNo":{"type":"string","default":"1","description":"Site No."},"goodsNo":{"type":"string","description":"Product No."},"entrNo":{"type":"string","description":"Vendor No."}}},"ReturnOrChangeInfoResponse":{"type":"object","description":"Return/Exchange Info Response","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type Code (PR008)"},"deliProcTypCdNm":{"type":"string","description":"Delivery Processing Type Code Name"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliGoodsGbCdNm":{"type":"string","description":"Delivery Product Classification Code Name"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliWayCdBNm":{"type":"string","description":"Delivery Method Code Name"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliPsbRgnCdNm":{"type":"string","description":"Deliverable Area Code Name"},"deliDday":{"type":"string","description":"Delivery Lead Time"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"entrNo":{"type":"string","description":"Vendor No."},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)"},"dlexTypCdNm":{"type":"string","description":"Delivery Fee Type Code Name"},"stdAmt":{"type":"integer","format":"int64","description":"Standard Amount"},"dlexAmt":{"type":"integer","format":"int64","description":"Delivery Fee Amount"},"wthdRtnAmt":{"type":"integer","format":"int64","description":"Return Pickup Fee"},"exchDlex":{"type":"integer","format":"int64","description":"Exchange Delivery Fee"},"addDlexAmt":{"type":"integer","format":"int64","description":"Additional Shipping Fee Amount"},"useYn":{"type":"string","description":"Usage Status"},"etEntrDlvpInfoList":{"type":"array","description":"Vendor Delivery Location Information","items":{"$ref":"#/components/schemas/EtEntrDlvpInfo"}}}},"EtEntrDlvpInfo":{"type":"object","description":"Vendor Delivery Location Information","properties":{"entrDlvpNo":{"type":"string","description":"Vendor Delivery Location No."},"entrNo":{"type":"string","description":"Vendor No."},"dlvpTypCd":{"type":"string","description":"Delivery Location Type Code (VD007) 10: Shipping Location, 20: Return Location"},"dlvpTypCdNm":{"type":"string","description":"Delivery Address Type Code Name"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"useYn":{"type":"string","description":"Usage Status"},"zipNoSeq":{"type":"string","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"utakmnNm":{"type":"string","description":"Person in Charge Name"},"aempTelRgnNo":{"type":"string","description":"Contact Person's Phone Area Code"},"aempTelTxnoNo":{"type":"string","description":"Contact Person's Phone Exchange Code"},"aempTelEndNo":{"type":"string","description":"Contact Person's Phone Last Digits"},"aempCellSctNo":{"type":"string","description":"Contact Person's Mobile Phone Prefix Code"},"aempCellTxnoNo":{"type":"string","description":"Contact Person's Mobile Phone Exchange Code"},"aempCellEndNo":{"type":"string","description":"Contact Person's Mobile Phone Last Digits"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/delivery/tr/{entrNo}":{"get":{"tags":["Product Detail Delivery Information"],"summary":"Retrieve Delivery/Exchange/Return Info by Partner","description":"## Function Description\n* This API retrieves return/exchange information.\n---\n## Detailed Description\n* Retrieves the list of basic delivery policy information using the partner number value.\n * Retrieves delivery policies whose basic usage status is Y.\n","operationId":"getTrReturnOrChangeInfo","parameters":[{"name":"entrNo","in":"path","description":"Vendor No.","required":true,"schema":{"type":"string","description":"String"}},{"name":"returnOrChangeInfo","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ReturnOrChangeInfo"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Return/Exchange Info by Partner Inquiry Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ReturnOrChangeInfoResponse"}}}},"900":{"description":"Return/Exchange Info by Partner Inquiry Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ``` ## Retrieve Delivery/Exchange/Return Info by Product > \## Function Description\ > \* This is the return/exchange information API used in the delivery/exchange/return layer popup on the product detail page.\ > \---\ > \## Detailed Description\ > \* Retrieves the basic delivery policy information and the partner delivery address information list using the product number value.\ > \* Retrieves delivery policies whose basic usage status is Y.
```json {"openapi":"3.1.0","info":{"title":"X2BEE Goods API","version":"v1"},"servers":[{"url":"https://api-goods.x2bee.com/api/goods/","description":"prd"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ReturnOrChangeInfo":{"type":"object","description":"Return/Exchange Info","properties":{"langCd":{"type":"string","default":"ko","description":"Language Code (CM009)"},"siteNo":{"type":"string","default":"1","description":"Site No."},"goodsNo":{"type":"string","description":"Product No."},"entrNo":{"type":"string","description":"Vendor No."}}},"ReturnOrChangeInfoResponse":{"type":"object","description":"Return/Exchange Info Response","properties":{"goodsNo":{"type":"string","description":"Product No."},"deliProcTypCd":{"type":"string","description":"Delivery Processing Type Code (PR008)"},"deliProcTypCdNm":{"type":"string","description":"Delivery Processing Type Code Name"},"deliGoodsGbCd":{"type":"string","description":"Delivery Product Classification Code (PR010)"},"deliGoodsGbCdNm":{"type":"string","description":"Delivery Product Classification Code Name"},"deliWayCd":{"type":"string","description":"Delivery Method Code (PR009)"},"deliWayCdBNm":{"type":"string","description":"Delivery Method Code Name"},"deliPsbRgnCd":{"type":"string","description":"Deliverable Area Code (PR030)"},"deliPsbRgnCdNm":{"type":"string","description":"Deliverable Area Code Name"},"deliDday":{"type":"string","description":"Delivery Lead Time"},"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"entrNo":{"type":"string","description":"Vendor No."},"bpckPsbYn":{"type":"string","description":"Combined Packaging Availability Status"},"rtnPsbYn":{"type":"string","description":"Return Availability Status"},"exchPsbYn":{"type":"string","description":"Exchange Availability Status"},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)"},"dlexTypCdNm":{"type":"string","description":"Delivery Fee Type Code Name"},"stdAmt":{"type":"integer","format":"int64","description":"Standard Amount"},"dlexAmt":{"type":"integer","format":"int64","description":"Delivery Fee Amount"},"wthdRtnAmt":{"type":"integer","format":"int64","description":"Return Pickup Fee"},"exchDlex":{"type":"integer","format":"int64","description":"Exchange Delivery Fee"},"addDlexAmt":{"type":"integer","format":"int64","description":"Additional Shipping Fee Amount"},"useYn":{"type":"string","description":"Usage Status"},"etEntrDlvpInfoList":{"type":"array","description":"Vendor Delivery Location Information","items":{"$ref":"#/components/schemas/EtEntrDlvpInfo"}}}},"EtEntrDlvpInfo":{"type":"object","description":"Vendor Delivery Location Information","properties":{"entrDlvpNo":{"type":"string","description":"Vendor Delivery Location No."},"entrNo":{"type":"string","description":"Vendor No."},"dlvpTypCd":{"type":"string","description":"Delivery Location Type Code (VD007) 10: Shipping Location, 20: Return Location"},"dlvpTypCdNm":{"type":"string","description":"Delivery Address Type Code Name"},"dlvpNm":{"type":"string","description":"Delivery Address Name"},"useYn":{"type":"string","description":"Usage Status"},"zipNoSeq":{"type":"string","description":"Postal Code Sequence No."},"zipNo":{"type":"string","description":"Postal Code"},"zipAddr":{"type":"string","description":"Postal Address"},"dtlAddr":{"type":"string","description":"Detailed Address"},"utakmnNm":{"type":"string","description":"Person in Charge Name"},"aempTelRgnNo":{"type":"string","description":"Contact Person's Phone Area Code"},"aempTelTxnoNo":{"type":"string","description":"Contact Person's Phone Exchange Code"},"aempTelEndNo":{"type":"string","description":"Contact Person's Phone Last Digits"},"aempCellSctNo":{"type":"string","description":"Contact Person's Mobile Phone Prefix Code"},"aempCellTxnoNo":{"type":"string","description":"Contact Person's Mobile Phone Exchange Code"},"aempCellEndNo":{"type":"string","description":"Contact Person's Mobile Phone Last Digits"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/delivery/pd/{goodsNo}":{"get":{"tags":["Product Detail Delivery Information"],"summary":"Retrieve Delivery/Exchange/Return Info by Product","description":"## Function Description\n* This is the return/exchange information API used in the delivery/exchange/return layer popup on the product detail page.\n---\n## Detailed Description\n* Retrieves the basic delivery policy information and the partner delivery address information list using the product number value.\n * Retrieves delivery policies whose basic usage status is Y.\n","operationId":"getPdReturnOrChangeInfo","parameters":[{"name":"goodsNo","in":"path","description":"Product No.","required":true,"schema":{"type":"string","description":"String"}},{"name":"returnOrChangeInfo","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ReturnOrChangeInfo"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Return/Exchange Info by Product Inquiry Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ReturnOrChangeInfoResponse"}}}},"900":{"description":"Return/Exchange Info by Product Inquiry Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ``` ## Retrieve Product Delivery Fee > \## Function Description\ > \* This is the basic delivery fee policy API based on product number.\ > \---\ > \## Detailed Description\ > \* Retrieves the list of basic delivery policy information using a list of product number values.\ > \* Retrieves delivery policies whose basic usage status is Y.\ > \---\ > \## Revision History\ > \`\`\`Release v1.04\_231120\`\`\` : Added transaction type code (VD002)
````json {"openapi":"3.1.0","info":{"title":"X2BEE Goods API","version":"v1"},"servers":[{"url":"https://api-goods.x2bee.com/api/goods/","description":"prd"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","name":"Authorization","in":"header","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"GoodsDeliPolcRequest":{"type":"object","description":"Product No. List Request","properties":{"langCd":{"type":"string","default":"ko","description":"Language Code (CM009)"},"siteNo":{"type":"string","default":"1","description":"Site No."},"goodsNos":{"type":"array","default":"1000030,1689483","description":"Product No. List","items":{"type":"string"}}}},"EtDeliPolcBaseResponse":{"type":"object","description":"Delivery Policy Basic Response","properties":{"deliPolcNo":{"type":"string","description":"Delivery Policy No."},"entrNo":{"type":"string","description":"Vendor No."},"dlexTypCd":{"type":"string","description":"Delivery Fee Type Code (VD005)"},"dlexTypCdNm":{"type":"string","description":"Delivery Fee Type Code Name"},"stdAmt":{"type":"integer","format":"int64","description":"Standard Amount"},"dlexAmt":{"type":"integer","format":"int64","description":"Delivery Fee Amount"},"wthdRtnAmt":{"type":"integer","format":"int64","description":"Return Pickup Fee"},"exchDlex":{"type":"integer","format":"int64","description":"Exchange Delivery Fee"},"addDlexInfoList":{"type":"array","description":"Additional Delivery Fee","items":{"$ref":"#/components/schemas/EtAddDlexInfoResponse"}},"useYn":{"type":"string","description":"Usage Status"},"trdTypCd":{"type":"string","description":"Transaction Type Code (VD002)"}}},"EtAddDlexInfoResponse":{"type":"object","description":"Additional Delivery Fee Information Response","properties":{"deliRegnGrpNo":{"type":"string","description":"Delivery Area Group No."},"deliRegnGrpNm":{"type":"string","description":"Delivery Area Group Name"},"addDlexAmt":{"type":"integer","format":"int64","description":"Additional Delivery Fee"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/delivery/goodsDeliProc":{"get":{"tags":["Product Detail Delivery Information"],"summary":"Retrieve Product Delivery Fee","description":"## Function Description\n* This is the basic delivery fee policy API based on product number.\n---\n## Detailed Description\n* Retrieves the list of basic delivery policy information using a list of product number values.\n * Retrieves delivery policies whose basic usage status is Y.\n---\n## Revision History\n```Release v1.04_231120``` : Added transaction type code (VD002)\n","operationId":"getGoodsDeliPolicyInfo","parameters":[{"name":"goodsDeliPolcRequest","in":"query","required":true,"schema":{"$ref":"#/components/schemas/GoodsDeliPolcRequest"}},{"name":"goodsNos","in":"query","description":"Product No.","required":true,"schema":{"type":"string","description":"List"}},{"name":"Authorization","in":"header","description":"Access Token","required":false}],"responses":{"200":{"description":"Delivery Fee by Product Inquiry Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/EtDeliPolcBaseResponse"}}}},"900":{"description":"Delivery Fee by Product Inquiry Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}} ````