발주서 목록을 하루단위 페이징 형태로 조회합니다. 예)(2020-02-01 ~ 2020-02-03)
페이지당 row사이즈 조정은 maxPerPage 파라미터를 통해 가능하며 다음 페이지는 [nextToken]을 이용하여 얻을 수 있습니다. Path Parameter 일부 제외, 발주서 목록 조회(분 단위 전체)와 전반적으로 구성이 같습니다.
페이지당 row사이즈 조정은 maxPerPage 파라미터를 통해 가능하며 다음 페이지는 [nextToken]을 이용하여 얻을 수 있습니다. Path Parameter 일부 제외, 발주서 목록 조회(분 단위 전체)와 전반적으로 구성이 같습니다.
※ 결제완료 상태에서 고객이 배송지를 변경할 수 있기 때문에 상품준비중 처리 이후에 꼭! 배송지 정보("receiver")가 변경되었느지 재확인해야 합니다. (발주서 단건 조회API를 이용하시는 것이 편리합니다. )
※ 발주서 목록 조회는 주문 건이 많을 경우, 타임아웃이 발생할 수 있습니다. [타임아웃 대처방법] 페이지 링크를 확인하신 후, 타임아웃 시간을 늘려주시기 바랍니다.
※ 반품완료건은 발주서 목록에서 조회 불가하기에 '반품 /취소 요청 목록 조회' API를 이용해주시기 바랍니다.
- 출고 전, "sellerProductName + sellerProductItemName"과 "vendorItemName"의 정보가 일치하는지 반드시 확인해주시기 바랍니다.
- 구성, 수량, 용량 등이 다르게 노출되고 있는 경우, 출고를 보류해주시고 온라인 문의 접수해주시면 빠르게 도움 드리도록 하겠습니다. ( 상품 정보가 잘못 노출되고 있습니다. > '네' 선택하여 접수해주세요.)
- 오노출로 확인되는 경우, 반영된 판매자 점수는 원복됩니다.
Path
GET
/v2/providers/openapi/apis/api/v4/vendors/{vendorId}/ordersheets
Example Endpoint
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v4/vendors/A00012345/ordersheets?createdAtFrom=2017-10-10&createdAtTo=2017-10-11&maxPerPage=2&status=INSTRUCT
Request Parameters
Path Segment Parameter
| Name | Required | Type | Description | |||
|---|---|---|---|---|---|---|
| vendorId | O | String |
판매자 ID
쿠팡에서 업체에게 발급한 고유 코드
예) A00012345 |
|||
Query String Parameter
| Name | Required | Type | Description | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| createdAtFrom | O | String |
검색 시작일시
yyyy-mm-dd 형태로 조회하기 원하는 시작 날짜 기입
ex) 2018-07-01 |
|||||||||||||||||
| createdAtTo | O | String |
검색 종료일시
yyyy-mm-dd 형태로 조회하기 원하는 종료 날짜 기입
ex) 2018-07-31 최대 31일까지 조회 가능합니다.
|
|||||||||||||||||
| status | O | String |
발주서 상태
|
|||||||||||||||||
| nextToken | String |
다음 페이지 조회를 위한 token값
첫번째 페이지 조회시에는 필요하지 않습니다.
페이지당 최대 50개까지 요청되므로, 이후 페이지를 조회하기 위해서는 [nextToken] 사용 필요 |
||||||||||||||||||
| maxPerPage | Number |
페이지당 최대 조회 요청 값
default = 50
|
||||||||||||||||||
| searchType | String |
search type for order sheets results
searchType=timeFrame이면 발주서 목록 조회(분단위 전체)로 수행되며, 그 외에는 발주서 목록 조회(일단위 페이징)로 수행됩니다.
|
||||||||||||||||||
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 |
배송메세지
optional
|
|||||||||||||||||
| 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
optional / 없는 경우 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
optional
|
|||||||||||||||||
| 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 |
주문시 출고예정일
(불리배송 출고예정일) optional / yyyy-mm-dd
|
|||||||||||||||||
| plannedShippingDate | String |
실제 출고예정일 (분리배송 시)
optional / yyyy-mm-dd
|
|||||||||||||||||
| invoiceNumberUploadDate | String |
운송장번호 업로드 일시
optional / yyyy-MM-dd'T'HH:mm:ss
|
|||||||||||||||||
| extraProperties | Object |
업체상품옵션 추가 정보
optional / 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 |
해외배송정보
optional
|
|||||||||||||||||
| personalCustomsClearanceCode | String |
개인통관 고유부호 optional
|
|||||||||||||||||
| orderersSsn | String |
미사용
optional
|
|||||||||||||||||
| 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
|
|||||||||||||||||
| nextToken | String |
다음 페이지 요청 전송시 필요한 token 값
마지막 페이지인 경우 빈 값으로 리턴
|
|||||||||||||||||
Response Example
{
"code": 200,
"message": "OK",
"data": [
{
"shipmentBoxId": 64253897***6401429,
"orderId": 9100041863244,
"orderedAt": "2024-04-08T22:54:46",
"orderer": {
"name": "이*주",
"email": "",
"safeNumber": "0502-4***-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-4***-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"
},
{
"shipmentBoxId": 64253897***6401428,
"orderId": 4100042183223,
"orderedAt": "2024-04-09T13:02:02",
"orderer": {
"name": "류*영",
"email": "st*****@na",
"safeNumber": "0502-4***-5824",
"ordererNumber": null
},
"paidAt": "2024-04-09T13:02:11",
"status": "FINAL_DELIVERY",
"shippingPrice": 0,
"remotePrice": 0,
"remoteArea": false,
"parcelPrintMessage": "직접 받고 부재 시 문 앞",
"splitShipping": false,
"ableSplitShipping": false,
"receiver": {
"name": "류*영",
"safeNumber": "0502-41***-5824",
"receiverNumber": null,
"addr1": "***",
"addr2": "***",
"postCode": "1***3"
},
"orderItems": [
{
"vendorItemPackageId": 0,
"vendorItemPackageName": "신서리티 캘리포니아 레몬과즙 파우더 150g",
"productId": 6875929180,
"vendorItemId": 83653589505,
"vendorItemName": "신서리티 미국산 레몬 가루 150g x 3개",
"shippingCount": 1,
"salesPrice": 40400,
"orderPrice": 40400,
"discountPrice": 0,
"instantCouponDiscount": 0,
"downloadableCouponDiscount": 0,
"coupangDiscount": 0,
"externalVendorSkuCode": "",
"etcInfoHeader": null,
"etcInfoValue": null,
"etcInfoValues": null,
"sellerProductId": 13653570850,
"sellerProductName": "신서리티 미국산 레몬 가루 150g x 3개",
"sellerProductItemName": "3개 150g",
"firstSellerProductItemName": "3개 150g",
"cancelCount": 0,
"holdCountForCancel": 0,
"estimatedShippingDate": "2024-04-11",
"plannedShippingDate": "",
"invoiceNumberUploadDate": "2024-04-09T19:15:36",
"extraProperties": {
},
"pricingBadge": false,
"usedProduct": false,
"confirmDate": null,
"deliveryChargeTypeName": "무료",
"upBundleVendorItemId": null,
"upBundleVendorItemName": null,
"upBundleSize": null,
"upBundleItem": false,
"canceled": false
}
],
"overseaShippingInfoDto": {
"personalCustomsClearanceCode": "",
"ordererSsn": "",
"ordererPhoneNumber": ""
},
"deliveryCompanyName": "로젠택배",
"invoiceNumber": "***11719925",
"inTrasitDateTime": "2024-04-09 22:40:00",
"deliveredDate": "2024-04-11 16:11:00",
"refer": "안드로이드앱",
"shipmentType": "THIRD_PARTY"
}
],
"nextToken": "448537989"
}
Error Spec
| HTTP 상태 코드(오류 유형) | 오류 메시지 | 해결 방법 |
|---|---|---|
| 400 (요청변수확인) | Invalid vendor ID | 올바른 판매자 ID(vendorId)를 입력했는지 확인합니다. 예) A00012345 |
| 400 (요청변수확인) | endTime-startTime range should less than31. | 조회기간이 31일 이내 인지 확인합니다. |
URL API Name
GET_ORDERSHEET