coupang
API 문서
상품 API카테고리 API브랜드 API배송 / 주문 API반품 API교환 API프로모션 / 쿠폰물류 정보고객 문의정산CGF / CGF liteRocket Growth
PATCH/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/ordersheets/acknowledgement2609170000

상품준비중 처리

KRTW
# 01

요약

상품준비중 처리

# 02

상세

API 적용 가능한 구매자 사용자 지역: 한국, 대만

주문상태를 "결제완료" 에서 "상품준비중"으로 변경합니다. 상태변경을 요청한 주문 중 취소 건이 있으면 Partial Error를 리턴합니다.
※ 전체 또는 부분 결제 취소를 통해 환불이 진행중인 주문이 포함되어 있다면 해당 주문에 대해서는 "배송상태를 변경할 수 없습니다. 주문내역을 확인해주세요."라는 메세지가 반환됩니다.
환불이 완료된 시점에 취소 요청 상품 이외의 상품이 포함된 주문은 상품준비중으로 변경 가능합니다.

결제완료 단계의 shipmentBoxIds에 대해서만 적용이 가능합니다.
shipmentBoxIds 리스트 배열의 크기가 클 경우 타임아웃 에러가 발생할 수 있으니 50개 이하 또는 단 건으로 요청해야합니다.

<주의!> 결제완료 상태에서 고객이 배송지를 변경할 수 있기 때문에
상품준비중 처리 이후에 꼭! 발주서 단건 조회를 통해 배송지 정보가 변경되었는지 확인 및 업데이트를 해야합니다.

경로

PATCH/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/ordersheets/acknowledgement

예시 엔드포인트

https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/ordersheets/acknowledgement

URL API Name

UPDATE_ORDERSHEET_STATUS
# 03

Path 파라미터

NameTypeDescription
vendorId*string
판매자 ID

쿠팡에서 업체에게 발급한 고유 코드

예) A00012345
# 04

요청 본문

요청 파라미터

본문 파라미터

NameTypeDescription
vendorId*string
판매자 ID

쿠팡에서 업체에게 발급한 고유 코드

예) A00012345
shipmentBoxIds*object[]
상품준비중 상태로 변경할 묶음배송번호 목록
최대 50개 까지만 요청 요망
요청 예시application/json
{
  "vendorId": "A00012345",
  "shipmentBoxIds": [
    123456789012345680,
    123456789012345680
  ]
}
# 05

응답 본문

응답 메시지

NameTypeDescription
codestring
서버 응답 코드
messagestring
서버 응답 메세지
dataobject
ordersheet 상태변경 api 호출 결과 객체
responseKey
data.responseKey
integer
request에 대한 구분값
시스템 메타 데이터
responseCode
data.responseCode
integer
request 전체결과값에 대한 상태코드
Code Message
-1 None
0 All succeeded.
1 Partial errors.
99 All Failed.
responseMessage
data.responseMessage
string
request 전체결과값에 대한 상태메세지
responseList
data.responseList
object[]
개별 건에 대한 결과셋
shipmentBoxId
data.responseList[].shipmentBoxId
integer
묶음배송번호
succeed
data.responseList[].succeed
boolean
성공여부
resultCode
data.responseList[].resultCode
string
결과코드
retryRequired
data.responseList[].retryRequired
boolean
retry 가능 여부
resultMessage
data.responseList[].resultMessage
string
결과메세지

Response Example

{
  "code": "200",
  "message": "OK",
  "data": {
    "responseKey": -7326489997410940000,
    "responseCode": 1,
    "responseMessage": "apply instructStatus result - Partial errors.",
    "responseList": [
      {
        "shipmentBoxId": 123456789012345680,
        "succeed": true,
        "resultCode": "OK",
        "retryRequired": false,
        "resultMessage": "request succeeded."
      },
      {
        "shipmentBoxId": 123456789012345680,
        "succeed": false,
        "resultCode": "NOT_FOUND_SHIPMENT_BOX",
        "retryRequired": true,
        "resultMessage": "shipmentBoxId (123456789012345679) is not found."
      }
    ]
  }
}
# 06

에러 코드

HTTP코드메시지
400HTTP_400Bad Request

오류 사양

HTTP유형오류 메시지해결 방법
500500 (서버오류)

"code":500, "message" : "com.coupang.apigateway.pylon.ApiPreconditionException: Timeout waiting for connection from pool"

내부 시스템 부하 증가로 인한 일시적인 오류입니다. 일정시간 이후 재요청합니다.

504504 (서버오류)

"code" : "ERROR", "message" : "Request timed out, if the situation continues consider applying timeout extension."

내부 시스템 부하 증가로 인한 일시적인 오류입니다. 발주서 단건 조회 API로 상품준비중으로 변경되었는지 확인하고 변경이 안되어 있을 경우 일정시간 이후 재시도합니다.

521521 (서버오류)

code" : "ERROR", "message" : "connection timed out: aws-openapi.coupang.net/10.211.51.172:80"

내부 시스템 부하 증가로 인한 일시적인 오류입니다. 발주서 단건 조회 API로 상품준비중으로 변경되었는지 확인하고 변경이 안되어 있을 경우 일정시간 이후 재시도합니다.