잘못 등록한 운송장 내용을 변경합니다.
변경된 운송장의 배송상태는 배송지시(DEPARTURE)로 변경되며 이후 트래킹 정보 연동에 따라 변경될 수 있습니다.
변경된 운송장의 배송상태는 배송지시(DEPARTURE)로 변경되며 이후 트래킹 정보 연동에 따라 변경될 수 있습니다.
<주의!> 배송상태가 배송지시(DEPARTURE), 배송중(DELIVERING), 배송완료(FINAL_DELIVERY), 업체직송(NONE_TRACKING) 상태일 때만 운송장정보 변경이 가능합니다. (나머지 상태에서는 에러 발생).
Path
POST
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/orders/updateInvoices
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/orders/updateInvoices
Request Parameters
Path Segment Parameter
Name | Required | Type | Description | ||||
---|---|---|---|---|---|---|---|
vendorId | O | String |
판매자 ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345
|
Body Parameter
Name | Required | Type | Description | ||||
---|---|---|---|---|---|---|---|
vendorId | O | String |
판매자 ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345
|
||||
orderSheetInvoiceApplyDtos | O | Object |
배송지시 상태로 변경할 대상 정보 목록
|
||||
shipmentBoxId | O | Number |
묶음배송번호
|
||||
orderId | O | Number |
주문번호
|
||||
deliveryCompanyCode | O | String |
변경할 택배사 코드
|
||||
invoiceNumber | O | String |
변경할 송장번호
|
||||
vendorItemId | O | Number |
옵션 ID
송장을 업데이트할 상품의 옵션 ID를 입력.
|
||||
splitShipping | O | Boolean |
분리배송 여부
● false(전체배송)
1개의 주문번호에 포함된 전체 상품을 1개의 송장번호로 배송하는 경우 ● true(분리배송) 1개의 주문번호에 포함 된 상품을 분리하여 여러 송장번호로 배송하는 경우 |
||||
preSplitShipped | O | Boolean |
분리 배송중인지 여부
● false
분리배송을 하지 않는 경우 (=splitshipping이 false인 경우) 해당 주문번호에 대해 처음으로 분리배송처리 할 경우 ● true 해당 주문번호에 이미 분리배송을 진행한 상품이 있을 경우 |
||||
estimatedShippingDate | O | String |
(분리배송)출고예정일
YYYY-MM-DD 포멧으로 분리배송 시에만 선택적으로 입력.
입력 하지 않는 경우 "" 공백을 입력한다. 분리배송 시, 송장번호 또는 출고예정일 둘 중 한가지만 입력.
|
Request Example
{
"vendorId": "A00012345",
"orderSheetInvoiceApplyDtos": [
{
"shipmentBoxId": 123456789012345678,
"orderId": 2000019631453,
"vendorItemId": 3819657333,
"deliveryCompanyCode": "KDEXP",
"invoiceNumber": 201808231414,
"splitShipping": "False",
"preSplitShipped": "False",
"estimatedShippingDate": ""
}
]
}
Response Message
Name | Type | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
code | Number |
서버 응답 코드
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message | String |
서버 응답 메세지
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data | Array |
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
responseCode | Number |
request 전체결과값에 대한 상태메세지
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
responseMessage | String |
request 전체결과값에 대한 상태메세지
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
responseList | Array |
개별 건에 대한 결과셋
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
shipmentBoxId | Number |
묶음배송번호
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
succeed | Boolean |
성공여부
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resultCode | String |
결과코드
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
resultMessage | String |
결과메세지
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retryRequired | Boolean |
retry 가능 여부
|
Response Example
{
"code": 200,
"message": "OK",
"data": {
"responseCode": 0,
"responseMessage": "SUCCESS",
"responseList": [
{
"shipmentBoxId": 123456789012345678,
"succeed": true,
"resultCode": "OK",
"retryRequired": false,
"resultMessage": null
}
]
}
}
Error Spec
HTTP 상태 코드(오류 유형) | 오류 메시지 | 해결 방법 |
---|---|---|
400 (요청변수확인) | CJ 대한통운의 송장번호 형식에 맞지않는 운송장 번호 입니다. [6255*****632] | 올바른 송장번호를 입력했는지 확인합니다. |
400 (요청변수확인) | CJ 대한통운의 운송장번호는 숫자로만 구성되어야 합니다. InvoiceNumber must be number. [6257-6**2-10***] | 올바른 송장번호를 입력했는지 확인합니다. 송장번호에 숫자 이외의 문자가 포함되었는지 확인합니다. |
400 (요청변수확인) | 업체직송의 운송장번호는 숫자로만 구성되어야 합니다. InvoiceNumber must be number. [***] | 업체직송(DIRECT)의 송장번호를 숫자로 입력합니다. 예) 202002031830 |
400 (요청변수확인) | invalid delivery company code: | 올바른 택배사 코드(deliveryCompanyCode)를 입력했는지 확인합니다. |
400 (요청변수확인) | OO택배의 송장번호 형식에 맞지않는 운송장 번호 입니다. [956****734] | 올바른 송장번호를 입력했는지 확인합니다. |
URL API Name
UPDATE_ORDER_INVOICE