orderId를 이용하여 발주서 단건을 조회하는 API입니다.
결제완료 상태에서 고객이 배송지를 변경할 수 있기 때문에
상품준비중 처리 이후에 꼭! 발주서 단건 조회를 통해 배송지 정보("receiver")가 변경되었는지 확인 및 업데이트를 해 주셔야 합니다.
- 출고 전, "sellerProductName + sellerProductItemName"과 "vendorItemName"의 정보가 일치하는지 반드시 확인해주시기 바랍니다.
- 구성, 수량, 용량 등이 다르게 노출되고 있는 경우, 출고를 보류해주시고 온라인 문의 접수해주시면 빠르게 도움 드리도록 하겠습니다. ( 상품 정보가 잘못 노출되고 있습니다. > '네' 선택하여 접수해주세요.)
- 오노출로 확인되는 경우, 반영된 판매자 점수는 원복됩니다.
Path
GET
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/{orderId}/ordersheets
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00013264/500000596/ordersheets
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | ||||
|---|---|---|---|---|---|---|---|
| vendorId | O |
업체코드
쿠팡에서 업체에게 발급한 고유 코드
Wing 로그인 후, 확인 가능 |
|||||
| orderId | O |
orderId
본 파라미터는 발주서 목록 조회 분단위 및 일단위를 통해 조회한 발주서 정보에 포함되어 있습니다.
orderId는 Number type입니다.
|
|||||
Request Example
not require body
Response Message
| Name | Type | Description | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Number |
서버 응답 코드
|
||||||||||||||||||
| message | String |
서버 응답 메세지
|
||||||||||||||||||
| data | Array |
|
||||||||||||||||||
| shipmentBoxId | Number |
배송번호
|
||||||||||||||||||
| orderId | Number |
주문번호
|
||||||||||||||||||
| orderedAt | String |
주문일시
yyyy-MM-dd'T'HH:mm:ss
|
||||||||||||||||||
| orderer | Object |
주문자
|
||||||||||||||||||
| name | String |
주문자 이름
|
||||||||||||||||||
| String |
주문자 email
미사용(빈값)
|
|||||||||||||||||||
| safeNumber | String |
수취인 연락처(안심번호)
|
||||||||||||||||||
| ordererNumber | String |
주문자 연락처(실전화번호)
null
|
||||||||||||||||||
| paidAt | String |
결제일시
yyyy-MM-dd'T'HH:mm:ss
|
||||||||||||||||||
| status | String |
발주서상태
|
||||||||||||||||||
| shippingPrice | Number |
배송비
|
||||||||||||||||||
| remotePrice | Number |
도서산간배송비
|
||||||||||||||||||
| remoteArea | Boolean |
도서산간여부
|
||||||||||||||||||
| parcelPrintMessage | String |
배송메세지
|
||||||||||||||||||
| splitShipping | Boolean |
분리배송여부
|
||||||||||||||||||
| ableSplitShipping | Boolean |
분리배송가능여부
|
||||||||||||||||||
| receiver | Object |
수취인 정보
결제완료 단계에서만 고객이 변경가능합니다.
상품준비중 처리 이후에 변경되었는지 확인 및 업데이트 해야 합니다. |
||||||||||||||||||
| name | String |
수취인 이름
|
||||||||||||||||||
| safeNumber | String |
수취인 연락처(안심번호)
|
||||||||||||||||||
| receiverNumber | String |
수취인 연락처(실전화번호)
null
|
||||||||||||||||||
| addr1 | String |
수취인 배송지1
|
||||||||||||||||||
| addr2 | String |
수취인 배송지2
|
||||||||||||||||||
| postCode | String |
수취인 우편번호
|
||||||||||||||||||
| orderItems | Array |
Items to deliver
|
||||||||||||||||||
| vendorItemPackageId | Number |
vendorItemPackageId
없는 경우 0으로 리턴
|
||||||||||||||||||
| vendorItemPackageName | String |
vendorItemPackageName
|
||||||||||||||||||
| productId | Number |
productId
없는 경우 0으로 리턴
|
||||||||||||||||||
| vendorItemId | Number |
옵션ID
|
||||||||||||||||||
| vendorItemName | String |
노출상품명
|
||||||||||||||||||
| shippingCount | Number |
shippingCount = 주문시 item의 구매 수량
holdCountForCancel = 취소가 되어 환불 예정이 수량
cancelCount = 취소가 확정된 수량 발주 가능 수량 = shippingCount - (holdCountForCancel + cancelCount ) |
||||||||||||||||||
| salesPrice | Number |
개당 상품 가격(price of one item)
|
||||||||||||||||||
| orderPrice | Number |
결제 가격 : salesPrice*shippingCount
|
||||||||||||||||||
| discountPrice | Number |
총 할인 가격
discountPrice(총 할인 금액) = instantCouponDiscount(즉시할인 쿠폰) + downloadableCoupon(다운로드 쿠폰) + coupangDiscount(쿠팡 지원 할인) |
||||||||||||||||||
| instantCouponDiscount | Number |
즉시할인 쿠폰
즉시할인 쿠폰 할인 금액
|
||||||||||||||||||
| downloadableCouponDiscount | Number |
다운로드 쿠폰
다운로드 쿠폰 할인 금액
|
||||||||||||||||||
| coupangDiscount | Number |
쿠팡 지원 할인
쿠팡 지원 장바구니 / 카테고리 쿠폰 등의 금액
|
||||||||||||||||||
| externalVendorSkuCode | String |
external code
|
||||||||||||||||||
| etcInfoHeader | String |
상품별 개별 입력 항목
optional
|
||||||||||||||||||
| etcInfoValue | String |
상품별 개별 입력 항목에 대한 사용자의 입력값
optional
필드는 존재하나 값이 없는 상태입니다. 필요시에는 아래의 etcInfoValues를 사용하시기 바랍니다.
|
||||||||||||||||||
| etcInfoValues | Array |
상품별 개별 입력 항목에 대한 사용자의 입력값 리스트
optional
|
||||||||||||||||||
| sellerProductId | Number |
등록상품ID
|
||||||||||||||||||
| sellerProductName | String |
등록상품명
|
||||||||||||||||||
| sellerProductItemName | String |
등록옵션명
|
||||||||||||||||||
| firstSellerProductItemName | String |
최초등록옵션명
|
||||||||||||||||||
| cancelCount | Number |
취소수량
|
||||||||||||||||||
| holdCountForCancel | Number |
환불대기수량
|
||||||||||||||||||
| estimatedShippingDate | String |
주문시 출고예정일
yyyy-MM-dd
|
||||||||||||||||||
| plannedShippingDate | String |
실제 출고예정일 (분리배송 시)
yyyy-MM-dd
|
||||||||||||||||||
| invoiceNumberUploadDate | String |
운송장번호 업로드 일시
yyyy-MM-dd'T'HH:mm:ss
|
||||||||||||||||||
| extraProperties | Object |
업체상품옵션 추가 정보
key:value 형태
|
||||||||||||||||||
| pricingBadge | Boolean |
최저가 상품 여부
true/false
|
||||||||||||||||||
| usedProduct | Boolean |
중고 상품 여부
true/false
|
||||||||||||||||||
| confirmDate | String |
구매확정일자
yyyy-MM-dd HH:mm:ss
|
||||||||||||||||||
| deliveryChargeTypeName | String |
배송비구분
유료, 무료
|
||||||||||||||||||
| upBundleVendorItemId | Number |
자동생성옵션 ID
|
||||||||||||||||||
| upBundleVendorItemName | String |
자동생성옵션 노출상품명
|
||||||||||||||||||
| upBundleSize | Number |
자동생성옵션 개수
|
||||||||||||||||||
| upBundleItem | Boolean |
자동생성옵션 아이템 여부
true/false |
||||||||||||||||||
| canceled | Boolean |
주문 취소 여부
true/false
|
||||||||||||||||||
| overseaShippingInfoDto | Object |
해외배송정보
|
||||||||||||||||||
| personalCustomsClearanceCode | String |
개인통관 고유부호 |
||||||||||||||||||
| orderersSsn | String |
미사용
|
||||||||||||||||||
| ordererPhoneNumber | String |
통관용 구매자 전화번호
|
||||||||||||||||||
| deliveryCompanyName | String |
택배사
CJ 대한통운,한진택배
|
||||||||||||||||||
| invoiceNumber | String |
운송장번호
|
||||||||||||||||||
| inTrasitDateTime | String |
출고일(발송일)
yyyy-MM-dd HH:mm:ss
|
||||||||||||||||||
| deliveredDate | String |
배송완료일
yyyy-MM-dd HH:mm:ss
|
||||||||||||||||||
| refer | String |
결제위치
아이폰앱,안드로이드앱,PC웹
|
||||||||||||||||||
| shipmentType | String |
배송유형
THIRD_PARTY, CGF, CGF LITE
|
||||||||||||||||||
Response Example
{
"code": 200,
"message": "OK",
"data": [
{
"shipmentBoxId": 6423000933,
"orderId": 9100041863244,
"orderedAt": "2024-04-08T22:54:46",
"orderer": {
"name": "이*주",
"email": "",
"safeNumber": "0502-***6-3501",
"ordererNumber": null
},
"paidAt": "2024-04-08T22:54:56",
"status": "FINAL_DELIVERY",
"shippingPrice": 0,
"remotePrice": 0,
"remoteArea": false,
"parcelPrintMessage": "문 앞",
"splitShipping": false,
"ableSplitShipping": false,
"receiver": {
"name": "이*주",
"safeNumber": "0502-***6-3501",
"receiverNumber": null,
"addr1": "***",
"addr2": "***",
"postCode": "***84"
},
"orderItems": [
{
"vendorItemPackageId": 0,
"vendorItemPackageName": "신서리티 델타 구운 캐슈넛",
"productId": 7313251147,
"vendorItemId": 85872453655,
"vendorItemName": "신서리티 델타 구운 캐슈넛, 5개, 160g",
"shippingCount": 1,
"salesPrice": 41000,
"orderPrice": 41000,
"discountPrice": 0,
"instantCouponDiscount": 0,
"downloadableCouponDiscount": 0,
"coupangDiscount": 0,
"externalVendorSkuCode": "",
"etcInfoHeader": null,
"etcInfoValue": null,
"etcInfoValues": null,
"sellerProductId": 14091699106,
"sellerProductName": "신서리티 델타 구운 캐슈넛 160g",
"sellerProductItemName": "1개 160g",
"firstSellerProductItemName": "1개 160g",
"cancelCount": 0,
"holdCountForCancel": 0,
"estimatedShippingDate": "2024-04-09",
"plannedShippingDate": "",
"invoiceNumberUploadDate": "2024-04-09T19:15:38",
"extraProperties": {
},
"pricingBadge": false,
"usedProduct": false,
"confirmDate": null,
"deliveryChargeTypeName": "무료",
"upBundleVendorItemId": 88049657337,
"upBundleVendorItemName": "신서리티 델타 구운 캐슈넛, 5개, 160g",
"upBundleSize": 5,
"upBundleItem": true,
"canceled": false
}
],
"overseaShippingInfoDto": {
"personalCustomsClearanceCode": "",
"ordererSsn": "",
"ordererPhoneNumber": ""
},
"deliveryCompanyName": "로젠택배",
"invoiceNumber": "***00402083",
"inTrasitDateTime": "2024-04-09 22:41:00",
"deliveredDate": "2024-04-11 09:57:00",
"refer": "안드로이드앱",
"shipmentType": "THIRD_PARTY"
}
]
}
Error Spec
| HTTP 상태 코드 (오류 유형) | 오류 메시지 | 해결 방법 |
|---|---|---|
| 400 (요청변수확인) | 해당 주문이 취소 또는 반품 되었습니다. | 반품/취소 요청 목록 조회 API를 통해 해당주문의 취소, 반품여부를 확인합니다. 해당 주문을 반복 호출하지 않도록 처리합니다. |
| 400 (요청변수확인) | 유효하지 않은 주문번호 입니다. | 정상적인 주문번호인지 확인합니다. |
| 400 (요청변수확인) |
다른 판매자의 주문을 조회할 수 없습니다. |
판매자ID(vendorId)를 올바로 입력했는지 확인합니다. |
URL API Name
GET_ORDERSHEET_BY_ORDERID