Product Detail Delivery Information

Process Item Option Out-of-Stock Due to Loss Processing

post

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. .

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

AuthorizationanyOptional

Access Token

Body

Product Detail Inquiry Request DTO

targetOrdDtlStatCdstringOptional

Loss Processing Type 22: Loss Release, 23: Loss Registration

Example: 23

Responses

200

*/*

objectOptional

post/v1/delivery/updatePrItmStockByInsuff

POST /api/goods/v1/delivery/updatePrItmStockByInsuff HTTP/1.1
Host: api-goods.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 123

{
  "targetOrdDtlStatCd": 23,
  "prItms": [
    {
      "goodsNo": 100000001,
      "itmNo": "001",
      "itmSaleStatCd": 10,
      "soutCausCd": 11,
      "userId": "test"
    }
  ]
}

200

{}

Retrieve Delivery Fee by Delivery Policy No.

post

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

AuthorizationanyOptional

Access Token

Bodyobject · EtDeliPolcBaseRequest[]

Delivery Policy Basic Request

langCdstringOptional

Language Code (CM009)

Default: koExample: ko

siteNostringOptional

Site No.

Default: 1Example: 1

entrNostringOptional

Vendor No.

Default: 10000001

deliPolcNostringOptional

Delivery Policy No.

Default: 10000271

Responses

200

Delivery Fee Policy Inquiry Success

*/*

Delivery Policy Basic Response

deliPolcNostringOptional

Delivery Policy No.

entrNostringOptional

Vendor No.

dlexTypCdstringOptional

Delivery Fee Type Code (VD005)

dlexTypCdNmstringOptional

Delivery Fee Type Code Name

stdAmtinteger · int64Optional

Standard Amount

dlexAmtinteger · int64Optional

Delivery Fee Amount

wthdRtnAmtinteger · int64Optional

Return Pickup Fee

exchDlexinteger · int64Optional

Exchange Delivery Fee

useYnstringOptional

Usage Status

trdTypCdstringOptional

Transaction Type Code (VD002)

900

Delivery Fee Policy Inquiry Failure

*/*

post/v1/delivery/deliProcInfo

POST /api/goods/v1/delivery/deliProcInfo HTTP/1.1
Host: api-goods.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

[
  {
    "langCd": "ko",
    "siteNo": 1,
    "entrNo": "10000001",
    "deliPolcNo": "10000271"
  }
]

{
  "deliPolcNo": "text",
  "entrNo": "text",
  "dlexTypCd": "text",
  "dlexTypCdNm": "text",
  "stdAmt": 1,
  "dlexAmt": 1,
  "wthdRtnAmt": 1,
  "exchDlex": 1,
  "addDlexInfoList": [
    {
      "deliRegnGrpNo": "text",
      "deliRegnGrpNm": "text",
      "addDlexAmt": 1
    }
  ],
  "useYn": "text",
  "trdTypCd": "text"
}

Retrieve Delivery/Exchange/Return Info by Partner

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

entrNostringRequired

String

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Return/Exchange Info by Partner Inquiry Success

*/*

Return/Exchange Info Response

goodsNostringOptional

Product No.

deliProcTypCdstringOptional

Delivery Processing Type Code (PR008)

deliProcTypCdNmstringOptional

Delivery Processing Type Code Name

deliGoodsGbCdstringOptional

Delivery Product Classification Code (PR010)

deliGoodsGbCdNmstringOptional

Delivery Product Classification Code Name

deliWayCdstringOptional

Delivery Method Code (PR009)

deliWayCdBNmstringOptional

Delivery Method Code Name

deliPsbRgnCdstringOptional

Deliverable Area Code (PR030)

deliPsbRgnCdNmstringOptional

Deliverable Area Code Name

deliDdaystringOptional

Delivery Lead Time

deliPolcNostringOptional

Delivery Policy No.

entrNostringOptional

Vendor No.

bpckPsbYnstringOptional

Combined Packaging Availability Status

rtnPsbYnstringOptional

Return Availability Status

exchPsbYnstringOptional

Exchange Availability Status

dlexTypCdstringOptional

Delivery Fee Type Code (VD005)

dlexTypCdNmstringOptional

Delivery Fee Type Code Name

stdAmtinteger · int64Optional

Standard Amount

dlexAmtinteger · int64Optional

Delivery Fee Amount

wthdRtnAmtinteger · int64Optional

Return Pickup Fee

exchDlexinteger · int64Optional

Exchange Delivery Fee

addDlexAmtinteger · int64Optional

Additional Shipping Fee Amount

useYnstringOptional

Usage Status

900

Return/Exchange Info by Partner Inquiry Failure

*/*

get/v1/delivery/tr/{entrNo}

GET /api/goods/v1/delivery/tr/{entrNo}?returnOrChangeInfo=[object+Object] HTTP/1.1
Host: api-goods.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "goodsNo": "text",
  "deliProcTypCd": "text",
  "deliProcTypCdNm": "text",
  "deliGoodsGbCd": "text",
  "deliGoodsGbCdNm": "text",
  "deliWayCd": "text",
  "deliWayCdBNm": "text",
  "deliPsbRgnCd": "text",
  "deliPsbRgnCdNm": "text",
  "deliDday": "text",
  "deliPolcNo": "text",
  "entrNo": "text",
  "bpckPsbYn": "text",
  "rtnPsbYn": "text",
  "exchPsbYn": "text",
  "dlexTypCd": "text",
  "dlexTypCdNm": "text",
  "stdAmt": 1,
  "dlexAmt": 1,
  "wthdRtnAmt": 1,
  "exchDlex": 1,
  "addDlexAmt": 1,
  "useYn": "text",
  "etEntrDlvpInfoList": [
    {
      "entrDlvpNo": 1,
      "entrNo": 1000001,
      "dlvpTypCd": 10,
      "dlvpTypCdNm": "출고지",
      "dlvpNm": "배송지",
      "useYn": "Y",
      "zipNoSeq": 1,
      "zipNo": 123,
      "zipAddr": "서울시 강남구",
      "dtlAddr": "상세주소",
      "utakmnNm": "홍길동",
      "aempTelRgnNo": "02",
      "aempTelTxnoNo": 1234,
      "aempTelEndNo": 1234,
      "aempCellSctNo": "010",
      "aempCellTxnoNo": 1234,
      "aempCellEndNo": 1234
    }
  ]
}

Retrieve Delivery/Exchange/Return Info by Product

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

goodsNostringRequired

String

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Return/Exchange Info by Product Inquiry Success

*/*

Return/Exchange Info Response

goodsNostringOptional

Product No.

deliProcTypCdstringOptional

Delivery Processing Type Code (PR008)

deliProcTypCdNmstringOptional

Delivery Processing Type Code Name

deliGoodsGbCdstringOptional

Delivery Product Classification Code (PR010)

deliGoodsGbCdNmstringOptional

Delivery Product Classification Code Name

deliWayCdstringOptional

Delivery Method Code (PR009)

deliWayCdBNmstringOptional

Delivery Method Code Name

deliPsbRgnCdstringOptional

Deliverable Area Code (PR030)

deliPsbRgnCdNmstringOptional

Deliverable Area Code Name

deliDdaystringOptional

Delivery Lead Time

deliPolcNostringOptional

Delivery Policy No.

entrNostringOptional

Vendor No.

bpckPsbYnstringOptional

Combined Packaging Availability Status

rtnPsbYnstringOptional

Return Availability Status

exchPsbYnstringOptional

Exchange Availability Status

dlexTypCdstringOptional

Delivery Fee Type Code (VD005)

dlexTypCdNmstringOptional

Delivery Fee Type Code Name

stdAmtinteger · int64Optional

Standard Amount

dlexAmtinteger · int64Optional

Delivery Fee Amount

wthdRtnAmtinteger · int64Optional

Return Pickup Fee

exchDlexinteger · int64Optional

Exchange Delivery Fee

addDlexAmtinteger · int64Optional

Additional Shipping Fee Amount

useYnstringOptional

Usage Status

900

Return/Exchange Info by Product Inquiry Failure

*/*

get/v1/delivery/pd/{goodsNo}

GET /api/goods/v1/delivery/pd/{goodsNo}?returnOrChangeInfo=[object+Object] HTTP/1.1
Host: api-goods.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "goodsNo": "text",
  "deliProcTypCd": "text",
  "deliProcTypCdNm": "text",
  "deliGoodsGbCd": "text",
  "deliGoodsGbCdNm": "text",
  "deliWayCd": "text",
  "deliWayCdBNm": "text",
  "deliPsbRgnCd": "text",
  "deliPsbRgnCdNm": "text",
  "deliDday": "text",
  "deliPolcNo": "text",
  "entrNo": "text",
  "bpckPsbYn": "text",
  "rtnPsbYn": "text",
  "exchPsbYn": "text",
  "dlexTypCd": "text",
  "dlexTypCdNm": "text",
  "stdAmt": 1,
  "dlexAmt": 1,
  "wthdRtnAmt": 1,
  "exchDlex": 1,
  "addDlexAmt": 1,
  "useYn": "text",
  "etEntrDlvpInfoList": [
    {
      "entrDlvpNo": 1,
      "entrNo": 1000001,
      "dlvpTypCd": 10,
      "dlvpTypCdNm": "출고지",
      "dlvpNm": "배송지",
      "useYn": "Y",
      "zipNoSeq": 1,
      "zipNo": 123,
      "zipAddr": "서울시 강남구",
      "dtlAddr": "상세주소",
      "utakmnNm": "홍길동",
      "aempTelRgnNo": "02",
      "aempTelTxnoNo": 1234,
      "aempTelEndNo": 1234,
      "aempCellSctNo": "010",
      "aempCellTxnoNo": 1234,
      "aempCellEndNo": 1234
    }
  ]
}

Retrieve Product Delivery Fee

get

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)

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

goodsNosstringRequired

List

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Delivery Fee by Product Inquiry Success

*/*

Delivery Policy Basic Response

deliPolcNostringOptional

Delivery Policy No.

entrNostringOptional

Vendor No.

dlexTypCdstringOptional

Delivery Fee Type Code (VD005)

dlexTypCdNmstringOptional

Delivery Fee Type Code Name

stdAmtinteger · int64Optional

Standard Amount

dlexAmtinteger · int64Optional

Delivery Fee Amount

wthdRtnAmtinteger · int64Optional

Return Pickup Fee

exchDlexinteger · int64Optional

Exchange Delivery Fee

useYnstringOptional

Usage Status

trdTypCdstringOptional

Transaction Type Code (VD002)

900

Delivery Fee by Product Inquiry Failure

*/*

get/v1/delivery/goodsDeliProc

GET /api/goods/v1/delivery/goodsDeliProc?goodsDeliPolcRequest=[object+Object]&goodsNos=text HTTP/1.1
Host: api-goods.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "deliPolcNo": "text",
  "entrNo": "text",
  "dlexTypCd": "text",
  "dlexTypCdNm": "text",
  "stdAmt": 1,
  "dlexAmt": 1,
  "wthdRtnAmt": 1,
  "exchDlex": 1,
  "addDlexInfoList": [
    {
      "deliRegnGrpNo": "text",
      "deliRegnGrpNm": "text",
      "addDlexAmt": 1
    }
  ],
  "useYn": "text",
  "trdTypCd": "text"
}

PreviousBrand

NextProduct Restock