Ctrlk
X2BEE Home
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Order Change

Change Order Delivery Address Customs ID Code (FO)

post

Function Description

  • [FO only] Changes the customs ID code of the order delivery address.

Detailed Description

  • Updates the order delivery address customs ID number based on the order number and delivery address sequence No.

Header parameters
AuthorizationanyOptional

Access Token

Body

Change Order Delivery Address Customs ID Code Request

ordNostringRequired

Order No.

dlvpSeqstringRequired

Delivery Address Sequence No.

persCstmCdstringRequired

Personal Customs Clearance Code

Responses
200

Success

No content
post/v1/claim/orderChange/ordDlvpPcccChangeFo
POST /api/order/v1/claim/orderChange/ordDlvpPcccChangeFo HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "ordNo": "text",
  "dlvpSeq": "text",
  "persCstmCd": "text"
}
No content

Modify Order Delivery Address (BO)

post

Function Description

  • [BO only] Changes the order delivery address.

Detailed Description

  • The delivery address can be changed when the order history type code (OM003) is Order Completed (11).

  • Updates all delivery sequence numbers for the corresponding order number, regardless of the delivery number.

  • The delivery address can only be changed between remote (island/mountain) areas that incur additional shipping fees, or between general areas.

Special Notes

  • The status values that allow the delivery address to be changed may vary depending on the ref_1_val (OM005) and ref_2_val (OM003) values of ST008 cd 92 (Change Delivery Address).

Revision History

  • Release v1.05_231204 : Added original delivery address sequence No. (orginDlvpSeq) to the request DTO; when an original delivery address sequence value is present, batch-updates the delivery sequence based on the order number and original delivery address sequence

  • Release v2.00_240711 : Modified so the delivery address can be changed within the same delivery region group with the same additional shipping fee amount

Header parameters
AuthorizationanyOptional

Access Token

Body

Order Delivery Address Change/Registration DTO

ordNostringRequired

Order No.

Example: 20230809O007943
clmNostringOptional

Claim No.

Example: 20230801C008072
systemTypestring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
mbrNostringOptional

Member No.

Example: 10000001
deliNostringRequired

Delivery No.

Example: 100008491
deliPolcNostringRequired

Delivery Policy No.

Example: 10000431
dlvpNmstringRequired

Delivery Address Name

Example: 집
rcvmnNmstringRequired

Recipient Name

Example: 홍길동
zipNoSeqinteger · int32Optional

Postal Code Sequence No.

Example: 1
zipNostringRequired

New Postal Code

Example: 8739
originZipNostringOptional

Previous Postal Code

Example: 5837
orginDlvpSeqstringOptional

Delivery Address Sequence No. Before Change

Example: 1
zipAddrstringRequired

Postal Address

Example: 서울 송파구 법원로9길
dtlAddrstringOptional

Detailed Address

Example: 에이치비지니스파크 D동 6층23
rcvmnCellSctNostringRequired

Recipient's Mobile Phone Prefix Code

Example: 010
rcvmnCellTxnoNostringRequired

Recipient's Mobile Phone Exchange Code

Example: 1234
rcvmnCellEndNostringRequired

Recipient's Mobile Phone Last Digits

Example: 5678
deliMsgstringOptional

Delivery Message

Example: 문 앞에 두고 가주세요.
deliMsgCdstringOptional

Delivery Message Code (ME039) 10: No delivery message, 20: Please call before delivery, 30: Leave at the door if absent, 40: Leave with security desk if absent, 50: Please deliver quickly, 60: Please call my mobile if absent, 70: Enter manually

Example: 10
comnFrdrEtcMethodstringOptional

Other Common Entrance Access Method

Example: 자유출입가능
comnFrdrPwdstringOptional

Common Entrance Password

Example: 1234
comnFrdrCogoMethodCdstringOptional

Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other

Example: 10
deliGbCdstring · enumOptional

LO001(Delivery Type Code) * 10 : Shipment * 20 : Return

Example: 10Possible values:
dlvpSeqstringOptional

Delivery Sequence No.

Example: 1
rcvmnEmailAddrstringOptional

Recipient Email

Example: test@plateer.com
rcvmnTelRgnNostringOptional

Recipient's Phone Area Code

Example: 02
rcvmnTelTxnoNostringOptional

Recipient's Phone Exchange Code

Example: 1234
rcvmnTelEndNostringOptional

Recipient's Phone Last Digits

Example: 5678
frgnDirPurGoodsYnstringOptional

Overseas Direct Purchase Product Status

Responses
200

Success

No content
post/v1/claim/orderChange/ordDlvChange
POST /api/order/v1/claim/orderChange/ordDlvChange HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 715

{
  "ordNo": "20230809O007943",
  "clmNo": "20230801C008072",
  "systemType": "10",
  "mbrNo": "10000001",
  "deliNo": "100008491",
  "deliPolcNo": "10000431",
  "dlvpNm": "집",
  "rcvmnNm": "홍길동",
  "zipNoSeq": 1,
  "zipNo": 8739,
  "originZipNo": 5837,
  "orginDlvpSeq": "1",
  "zipAddr": "서울 송파구 법원로9길",
  "dtlAddr": "에이치비지니스파크 D동 6층23",
  "rcvmnCellSctNo": "010",
  "rcvmnCellTxnoNo": "1234",
  "rcvmnCellEndNo": "5678",
  "deliMsg": "문 앞에 두고 가주세요.",
  "deliMsgCd": "10",
  "comnFrdrEtcMethod": "자유출입가능",
  "comnFrdrPwd": "1234",
  "comnFrdrCogoMethodCd": "10",
  "deliGbCd": "10",
  "dlvpSeq": "1",
  "rcvmnEmailAddr": "test@plateer.com",
  "rcvmnTelRgnNo": "02",
  "rcvmnTelTxnoNo": "1234",
  "rcvmnTelEndNo": "5678",
  "frgnDirPurGoodsYn": "text"
}
No content

Modify Order Delivery Address (FO)

post

Function Description

  • [FO only] Changes the order delivery address.

Detailed Description

  • The delivery address can be changed when the order history type code (OM003) is Order Completed (11).

  • Updates all delivery sequence numbers for the corresponding order number, regardless of the delivery number.

  • The delivery address can only be changed between remote (island/mountain) areas that incur additional shipping fees, or between general areas.

Special Notes

  • The status values that allow the delivery address to be changed may vary depending on the ref_1_val (OM005) and ref_2_val (OM003) values of ST007 cd 92 (Change Delivery Address).

Revision History

  • Release v1.05_231204 : Added original delivery address sequence No. (orginDlvpSeq) to the request DTO; when an original delivery address sequence value is present, batch-updates the delivery sequence based on the order number and original delivery address sequence

  • Release v2.00_240711 : Modified so the delivery address can be changed within the same delivery region group with the same additional shipping fee amount

Header parameters
AuthorizationanyOptional

Access Token

Body

Order Delivery Address Change/Registration DTO

ordNostringRequired

Order No.

Example: 20230809O007943
clmNostringOptional

Claim No.

Example: 20230801C008072
systemTypestring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
mbrNostringOptional

Member No.

Example: 10000001
deliNostringRequired

Delivery No.

Example: 100008491
deliPolcNostringRequired

Delivery Policy No.

Example: 10000431
dlvpNmstringRequired

Delivery Address Name

Example: 집
rcvmnNmstringRequired

Recipient Name

Example: 홍길동
zipNoSeqinteger · int32Optional

Postal Code Sequence No.

Example: 1
zipNostringRequired

New Postal Code

Example: 8739
originZipNostringOptional

Previous Postal Code

Example: 5837
orginDlvpSeqstringOptional

Delivery Address Sequence No. Before Change

Example: 1
zipAddrstringRequired

Postal Address

Example: 서울 송파구 법원로9길
dtlAddrstringOptional

Detailed Address

Example: 에이치비지니스파크 D동 6층23
rcvmnCellSctNostringRequired

Recipient's Mobile Phone Prefix Code

Example: 010
rcvmnCellTxnoNostringRequired

Recipient's Mobile Phone Exchange Code

Example: 1234
rcvmnCellEndNostringRequired

Recipient's Mobile Phone Last Digits

Example: 5678
deliMsgstringOptional

Delivery Message

Example: 문 앞에 두고 가주세요.
deliMsgCdstringOptional

Delivery Message Code (ME039) 10: No delivery message, 20: Please call before delivery, 30: Leave at the door if absent, 40: Leave with security desk if absent, 50: Please deliver quickly, 60: Please call my mobile if absent, 70: Enter manually

Example: 10
comnFrdrEtcMethodstringOptional

Other Common Entrance Access Method

Example: 자유출입가능
comnFrdrPwdstringOptional

Common Entrance Password

Example: 1234
comnFrdrCogoMethodCdstringOptional

Common Entrance Access Method Code (ME040) 10: Entrance access code, 20: Free access, 30: Other

Example: 10
deliGbCdstring · enumOptional

LO001(Delivery Type Code) * 10 : Shipment * 20 : Return

Example: 10Possible values:
dlvpSeqstringOptional

Delivery Sequence No.

Example: 1
rcvmnEmailAddrstringOptional

Recipient Email

Example: test@plateer.com
rcvmnTelRgnNostringOptional

Recipient's Phone Area Code

Example: 02
rcvmnTelTxnoNostringOptional

Recipient's Phone Exchange Code

Example: 1234
rcvmnTelEndNostringOptional

Recipient's Phone Last Digits

Example: 5678
frgnDirPurGoodsYnstringOptional

Overseas Direct Purchase Product Status

Responses
200

Success

No content
post/v1/claim/orderChange/ordDlvChangeFO
POST /api/order/v1/claim/orderChange/ordDlvChangeFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 715

{
  "ordNo": "20230809O007943",
  "clmNo": "20230801C008072",
  "systemType": "10",
  "mbrNo": "10000001",
  "deliNo": "100008491",
  "deliPolcNo": "10000431",
  "dlvpNm": "집",
  "rcvmnNm": "홍길동",
  "zipNoSeq": 1,
  "zipNo": 8739,
  "originZipNo": 5837,
  "orginDlvpSeq": "1",
  "zipAddr": "서울 송파구 법원로9길",
  "dtlAddr": "에이치비지니스파크 D동 6층23",
  "rcvmnCellSctNo": "010",
  "rcvmnCellTxnoNo": "1234",
  "rcvmnCellEndNo": "5678",
  "deliMsg": "문 앞에 두고 가주세요.",
  "deliMsgCd": "10",
  "comnFrdrEtcMethod": "자유출입가능",
  "comnFrdrPwd": "1234",
  "comnFrdrCogoMethodCd": "10",
  "deliGbCd": "10",
  "dlvpSeq": "1",
  "rcvmnEmailAddr": "test@plateer.com",
  "rcvmnTelRgnNo": "02",
  "rcvmnTelTxnoNo": "1234",
  "rcvmnTelEndNo": "5678",
  "frgnDirPurGoodsYn": "text"
}
No content

Change Order Product Option (BO)

post

Function Description

  • [BO only] Changes the order product option.

Detailed Description

  • The option can be changed when the order history type code (OM003) is Order Completed (11).

  • Multiple options can be changed at once.

  • Can be changed to a color+size unit item that is on sale with the same price and has stock available.

  • Cannot be changed to the same unit item or a unit item of a reservation product.

Special Notes

  • The status values that allow the delivery address to be changed may vary depending on the ref_1_val (OM005) and ref_2_val (OM003) values of ST008 cd 91 (Change Option).

Revision History

  • Release v2.00_241202: Fixed order change product filtering (Multi-delivery order change (BO) > case of changing the same product/unit item)

Header parameters
AuthorizationanyOptional

Access Token

Bodyobject · OrdGoodsInfoRequest[]

Order Option Change DTO

ordNostringRequired

Order No.

Example: 20230809O007943
ordSeqinteger · int32Required

Order Sequence No.

Example: 1
ordProcSeqinteger · int32Required

Order Processing Sequence No.

Example: 1
goodsNostringRequired

Product No.

Example: 10002552
itmNostringRequired

Item No.

Example: 001
chngItmNostringRequired

Changed SKU No.

Example: 002
ordQtyinteger · int32Optional

Quantity

Example: 1
salePrcinteger · int64Optional

Selling Price

Example: 5000
goodsNmstringOptional

Product Name

Example: 청바지
systemTypestring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
Responses
200

Success

No content
post/v1/claim/orderChange/ordChange
POST /api/order/v1/claim/orderChange/ordChange HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 174

[
  {
    "ordNo": "20230809O007943",
    "ordSeq": 1,
    "ordProcSeq": 1,
    "goodsNo": "10002552",
    "itmNo": "001",
    "chngItmNo": "002",
    "ordQty": 1,
    "salePrc": 5000,
    "goodsNm": "청바지",
    "systemType": "10"
  }
]
No content

Change Order Product Option (FO)

post

Function Description

  • [FO only] Changes the order product option.

Detailed Description

  • The option can be changed when the order history type code (OM003) is Order Completed (11).

  • Only a single option can be changed at a time.

  • Can be changed to a color+size unit item that is on sale with the same price and has stock available.

  • Cannot be changed to the same unit item or a unit item of a reservation product.

Special Notes

  • The status values that allow the delivery address to be changed may vary depending on the ref_1_val (OM005) and ref_2_val (OM003) values of ST007 cd 91 (Change Option).

Revision History

  • Release v2.00_241202: Fixed order change product filtering (Multi-delivery order change (BO) > case of changing the same product/unit item)

Header parameters
AuthorizationanyOptional

Access Token

Body

Order Option Change DTO

ordNostringRequired

Order No.

Example: 20230809O007943
ordSeqinteger · int32Required

Order Sequence No.

Example: 1
ordProcSeqinteger · int32Required

Order Processing Sequence No.

Example: 1
goodsNostringRequired

Product No.

Example: 10002552
itmNostringRequired

Item No.

Example: 001
chngItmNostringRequired

Changed SKU No.

Example: 002
ordQtyinteger · int32Optional

Quantity

Example: 1
salePrcinteger · int64Optional

Selling Price

Example: 5000
goodsNmstringOptional

Product Name

Example: 청바지
systemTypestring · enumOptional

SYSTEM (System Type) * 10 : FO * 20 : BO

Example: 10Possible values:
Responses
200

Success

No content
post/v1/claim/orderChange/ordChangeFO
POST /api/order/v1/claim/orderChange/ordChangeFO HTTP/1.1
Host: api-order.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 172

{
  "ordNo": "20230809O007943",
  "ordSeq": 1,
  "ordProcSeq": 1,
  "goodsNo": "10002552",
  "itmNo": "001",
  "chngItmNo": "002",
  "ordQty": 1,
  "salePrc": 5000,
  "goodsNm": "청바지",
  "systemType": "10"
}
No content
PreviousOrder Return
NextOrder Cancellation

Last updated