GET
/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/ordersheets/{shipmentBoxId}2609170000발주서 단건 조회(shipmentBoxId)
KRTW
# 01
요약
발주서 단건 조회(shipmentBoxId)
# 02
상세
API 적용 가능한 구매자 사용자 지역: 한국, 대만
shipmentBoxId를 이용하여 발주서 단건을 조회하는 API입니다.
결제완료 상태에서 고객이 배송지를 변경할 수 있기 때문에
상품준비중 처리 이후에 꼭! 발주서 단건 조회를 통해 배송지 정보("receiver")가 변경되었는지 확인 및 업데이트를 해 주셔야 합니다.
- 출고 전, "sellerProductName + sellerProductItemName"과 "vendorItemName"의 정보가 일치하는지 반드시 확인해주시기 바랍니다.
- 구성, 수량, 용량 등이 다르게 노출되고 있는 경우, 출고를 보류해주시고 온라인 문의 접수해주시면 빠르게 도움 드리도록 하겠습니다. (상품 정보가 잘못 노출되고 있습니다. > '네'선택하여 접수해주세요.)
- 오노출로 확인되는 경우, 반영된 판매자 점수는 원복됩니다.
경로
GET/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/ordersheets/{shipmentBoxId}
예시 엔드포인트
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v5/vendors/A00000001/ordersheets/642538971006401429URL API Name
GET_ORDERSHEET_BY_SHIPMENTBOX
# 03
Path 파라미터
| Name | Type | Description |
|---|---|---|
| vendorId* | object | 업체코드 쿠팡에서 업체에게 발급한 고유 코드 Wing 로그인 후, 확인 가능 |
| shipmentBoxId* | object | 배송번호(묶음배송번호) Wing 또는, 발주서 목록 조회 분단위/일단위를 통해 조회 shipmentBoxId는 Number type입니다. |
# 04
응답 본문
응답 메시지
| Name | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | number | 서버 응답 코드
| ||||||||||||||
| message | string | 서버 응답 메세지
| ||||||||||||||
| data | object | |||||||||||||||
| shipmentBoxId data.shipmentBoxId | number | 배송번호
| ||||||||||||||
| orderId data.orderId | number | 주문번호
| ||||||||||||||
| orderedAt data.orderedAt | string | 주문일시(ISO-8601표준을 준수해야 합니다.) YYYY-MM-DDThh:mm:ss.ssssss±hh:mm | ||||||||||||||
| orderer data.orderer | object | 주문자 정보
| ||||||||||||||
| name data.orderer.name | string | 주문자 이름
| ||||||||||||||
| email data.orderer.email | string | 주문자 E-mail 미사용(빈값) | ||||||||||||||
| safeNumber data.orderer.safeNumber | string | 수취인 연락처(안심번호)(E.164표준을 준수해야 합니다.)
| ||||||||||||||
| ordererNumber data.orderer.ordererNumber | string | 주문자 연락처(실전화번호)(E.164표준을 준수해야 합니다.) null | ||||||||||||||
| paidAt data.paidAt | string | 결제일시(ISO-8601표준을 준수해야 합니다.) YYYY-MM-DDThh:mm:ss.ssssss±hh:mm | ||||||||||||||
| status data.status | string | 발주서상태
| ||||||||||||||
| shippingPrice data.shippingPrice | object | 배송비
| ||||||||||||||
| currencyCode data.shippingPrice.currencyCode | string | 통화 코드 (ISO-4217 표준 준수), 대문자 3개
| ||||||||||||||
| units data.shippingPrice.units | number | 통화 정수 부분, 64 bit
| ||||||||||||||
| nanos data.shippingPrice.nanos | number | 통화 소수점 부분, 32 bit, 값 범위 [-9999999999, 999999999]
| ||||||||||||||
| remotePrice data.remotePrice | object | 도서산간배송비
| ||||||||||||||
| currencyCode data.remotePrice.currencyCode | string | 통화 코드 (ISO-4217 표준 준수), 대문자 3개
| ||||||||||||||
| units data.remotePrice.units | number | 통화 정수 부분, 64 bit
| ||||||||||||||
| nanos data.remotePrice.nanos | number | 통화 소수점 부분, 32 bit, 값 범위 [-9999999999, 999999999]
| ||||||||||||||
| remoteArea data.remoteArea | boolean | 도서산간여부
| ||||||||||||||
| parcelPrintMessage data.parcelPrintMessage | string | 배송메세지
| ||||||||||||||
| splitShipping data.splitShipping | boolean | 분리배송여부
| ||||||||||||||
| ableSplitShipping data.ableSplitShipping | boolean | 분리배송가능여부
| ||||||||||||||
| receiver data.receiver | object | 수취인 정보
| ||||||||||||||
| name data.receiver.name | string | 수취인 이름
| ||||||||||||||
| safeNumber data.receiver.safeNumber | string | 수취인 연락처(안심번호)(E.164표준을 준수해야 합니다.)
| ||||||||||||||
| receiverNumber data.receiver.receiverNumber | string | 수취인 연락처(실전화번호)(E.164표준을 준수해야 합니다.) null | ||||||||||||||
| addr1 data.receiver.addr1 | string | 수취인 배송지1
| ||||||||||||||
| addr2 data.receiver.addr2 | string | 수취인 배송지2
| ||||||||||||||
| postCode data.receiver.postCode | string | 수취인 우편번호
| ||||||||||||||
| consigneePrimaryAddress data.receiver.consigneePrimaryAddress | string | 우편번호 기반 수취인 기본 주소
| ||||||||||||||
| orderItems data.orderItems | object[] | 주문 상품 정보
| ||||||||||||||
| sequenceNo data.orderItems[].sequenceNo | string | 주문 상품 3자리 일련번호. "001"부터 시작
| ||||||||||||||
| vendorItemPackageId data.orderItems[].vendorItemPackageId | number | vendorItemPackageId 미사용 / 없는 경우 0으로 리턴 | ||||||||||||||
| vendorItemPackageName data.orderItems[].vendorItemPackageName | string | vendorItemPackageName 미사용 | ||||||||||||||
| productId data.orderItems[].productId | number | 노출상품ID 없는 경우 0으로 리턴 | ||||||||||||||
| vendorItemId data.orderItems[].vendorItemId | number | 옵션ID
| ||||||||||||||
| vendorItemName data.orderItems[].vendorItemName | string | 노출상품명
| ||||||||||||||
| shippingCount data.orderItems[].shippingCount | number | shippingCount = 주문시 item의 구매 수량 holdCountForCancel = 취소가 되어 환불 예정이 수량 cancelCount = 취소가 확정된 수량 발주 가능 수량 = shippingCount - (holdCountForCancel + cancelCount ) | ||||||||||||||
| salesPrice data.orderItems[].salesPrice | object | 개당 상품 가격(price of one item)
| ||||||||||||||
| currencyCode data.orderItems[].salesPrice.currencyCode | string | 통화 코드 (ISO-4217 표준 준수), 대문자 3개
| ||||||||||||||
| units data.orderItems[].salesPrice.units | number | 통화 정수 부분, 64 bit
| ||||||||||||||
| nanos data.orderItems[].salesPrice.nanos | number | 통화 소수점 부분, 32 bit, 값 범위 [-9999999999, 999999999]
| ||||||||||||||
| orderPrice data.orderItems[].orderPrice | object | 결제 가격 : salesPrice*shippingCount
| ||||||||||||||
| currencyCode data.orderItems[].orderPrice.currencyCode | string | 통화 코드 (ISO-4217 표준 준수), 대문자 3개
| ||||||||||||||
| units data.orderItems[].orderPrice.units | number | 통화 정수 부분, 64 bit
| ||||||||||||||
| nanos data.orderItems[].orderPrice.nanos | number | 통화 소수점 부분, 32 bit, 값 범위 [-9999999999, 999999999]
| ||||||||||||||
| discountPrice data.orderItems[].discountPrice | object | 총 할인 가격 discountPrice(총 할인 금액) = instantCouponDiscount(즉시할인 쿠폰) + downloadableCoupon(다운로드 쿠폰) + coupangDiscount(쿠팡 지원 할인) | ||||||||||||||
| currencyCode data.orderItems[].discountPrice.currencyCode | string | 통화 코드 (ISO-4217 표준 준수), 대문자 3개
| ||||||||||||||
| units data.orderItems[].discountPrice.units | number | 통화 정수 부분, 64 bit
| ||||||||||||||
| nanos data.orderItems[].discountPrice.nanos | number | 통화 소수점 부분, 32 bit, 값 범위 [-9999999999, 999999999]
| ||||||||||||||
| instantCouponDiscount data.orderItems[].instantCouponDiscount | object | 즉시할인 쿠폰 즉시할인 쿠폰 할인 금액 | ||||||||||||||
| currencyCode data.orderItems[].instantCouponDiscount.currencyCode | string | 통화 코드 (ISO-4217 표준 준수), 대문자 3개
| ||||||||||||||
| units data.orderItems[].instantCouponDiscount.units | number | 통화 정수 부분, 64 bit
| ||||||||||||||
| nanos data.orderItems[].instantCouponDiscount.nanos | number | 통화 소수점 부분, 32 bit, 값 범위 [-9999999999, 999999999]
| ||||||||||||||
| downloadableCouponDiscount data.orderItems[].downloadableCouponDiscount | object | 다운로드 쿠폰 다운로드 쿠폰 할인 금액 | ||||||||||||||
| currencyCode data.orderItems[].downloadableCouponDiscount.currencyCode | string | 통화 코드 (ISO-4217 표준 준수), 대문자 3개
| ||||||||||||||
| units data.orderItems[].downloadableCouponDiscount.units | number | 통화 정수 부분, 64 bit
| ||||||||||||||
| nanos data.orderItems[].downloadableCouponDiscount.nanos | number | 통화 소수점 부분, 32 bit, 값 범위 [-9999999999, 999999999]
| ||||||||||||||
| coupangDiscount data.orderItems[].coupangDiscount | object | 쿠팡 지원 할인 쿠팡 지원 장바구니 / 카테고리 쿠폰 등의 금액 | ||||||||||||||
| currencyCode data.orderItems[].coupangDiscount.currencyCode | string | 통화 코드 (ISO-4217 표준 준수), 대문자 3개
| ||||||||||||||
| units data.orderItems[].coupangDiscount.units | number | 통화 정수 부분, 64 bit
| ||||||||||||||
| nanos data.orderItems[].coupangDiscount.nanos | number | 통화 소수점 부분, 32 bit, 값 범위 [-9999999999, 999999999]
| ||||||||||||||
| externalVendorSkuCode data.orderItems[].externalVendorSkuCode | string | 업체 외부 상품 코드
| ||||||||||||||
| etcInfoHeader data.orderItems[].etcInfoHeader | string | 상품별 개별 입력 항목 optional | ||||||||||||||
| etcInfoValue data.orderItems[].etcInfoValue | string | 상품별 개별 입력 항목에 대한 사용자의 입력값 optional 미사용 | ||||||||||||||
| etcInfoValues data.orderItems[].etcInfoValues | object[] | 상품별 개별 입력 항목에 대한 사용자의 입력값 리스트 optional | ||||||||||||||
| sellerProductId data.orderItems[].sellerProductId | number | 등록상품ID
| ||||||||||||||
| sellerProductName data.orderItems[].sellerProductName | string | 등록상품명
| ||||||||||||||
| sellerProductItemName data.orderItems[].sellerProductItemName | string | 등록옵션명
| ||||||||||||||
| firstSellerProductItemName data.orderItems[].firstSellerProductItemName | string | 최초등록옵션명
| ||||||||||||||
| cancelCount data.orderItems[].cancelCount | number | 취소수량
| ||||||||||||||
| holdCountForCancel data.orderItems[].holdCountForCancel | number | 환불대기수량
| ||||||||||||||
| estimatedShippingDate data.orderItems[].estimatedShippingDate | string | 주문 시 출고예정일(ISO-8601표준을 준수해야 합니다.) yyyy-MM-dd | ||||||||||||||
| plannedShippingDate data.orderItems[].plannedShippingDate | string | 실제 출고예정일 (분리배송 시)(ISO-8601표준을 준수해야 합니다.) yyyy-MM-dd | ||||||||||||||
| invoiceNumberUploadDate data.orderItems[].invoiceNumberUploadDate | string | 운송장번호 업로드 일시(ISO-8601표준을 준수해야 합니다.) YYYY-MM-DDThh:mm:ss.ssssss±hh:mm | ||||||||||||||
| extraProperties data.orderItems[].extraProperties | object | 업체상품옵션 추가 정보 key:value 형태 | ||||||||||||||
| pricingBadge data.orderItems[].pricingBadge | boolean | 쿠런티(최저가 상품 여부) true/false | ||||||||||||||
| usedProduct data.orderItems[].usedProduct | boolean | 중고 상품 여부 true/false | ||||||||||||||
| confirmDate data.orderItems[].confirmDate | string | 구매확정일자(ISO-8601표준을 준수해야 합니다.) YYYY-MM-DDThh:mm:ss.ssssss±hh:mm | ||||||||||||||
| deliveryChargeTypeName data.orderItems[].deliveryChargeTypeName | string | 배송비구분 유료, 무료 | ||||||||||||||
| productCategoryLevel1 data.orderItems[].productCategoryLevel1 | string | 상품 분류 1단계 카테고리명
| ||||||||||||||
| productCategoryLevel2 data.orderItems[].productCategoryLevel2 | string | 상품 분류 2단계 카테고리명
| ||||||||||||||
| productSalesPageUrl data.orderItems[].productSalesPageUrl | string | 쿠팡 마켓플레이스 상품 판매 페이지 URL
| ||||||||||||||
| upBundleVendorItemId data.orderItems[].upBundleVendorItemId | number | 자동생성옵션 ID
| ||||||||||||||
| upBundleVendorItemName data.orderItems[].upBundleVendorItemName | string | 자동생성옵션 노출상품명
| ||||||||||||||
| upBundleSize data.orderItems[].upBundleSize | number | 자동생성옵션 개수
| ||||||||||||||
| upBundleItem data.orderItems[].upBundleItem | boolean | 자동생성옵션 아이템 여부 true/false | ||||||||||||||
| canceled data.orderItems[].canceled | boolean | 주문 취소 여부 true/false | ||||||||||||||
| overseaShippingInfoDto data.overseaShippingInfoDto | object | 해외배송정보
| ||||||||||||||
| personalCustomsClearanceCode data.overseaShippingInfoDto.personalCustomsClearanceCode | string | 개인통관 고유부호
| ||||||||||||||
| orderersSsn data.overseaShippingInfoDto.orderersSsn | string | 미사용(Not in use)
| ||||||||||||||
| ordererPhoneNumber data.overseaShippingInfoDto.ordererPhoneNumber | string | 통관용 수신자 전화번호(E.164표준을 준수해야 합니다.)
| ||||||||||||||
| oneTimePccc data.overseaShippingInfoDto.oneTimePccc | string | KCS(관세청) 발급 일회용 개인통관고유부호. 본인인증(CI) 기반 주문에 사용
| ||||||||||||||
| otpNumber data.overseaShippingInfoDto.otpNumber | string | 통관 검증용 OTP(일회용 비밀번호)
| ||||||||||||||
| deliveryCompanyName data.deliveryCompanyName | string | 택배사 Ex: CJ 대한통운,한진택배... | ||||||||||||||
| invoiceNumber data.invoiceNumber | string | 운송장번호
| ||||||||||||||
| inTrasitDateTime data.inTrasitDateTime | string | 출고일(발송일)(ISO-8601표준을 준수해야 합니다.) YYYY-MM-DDThh:mm:ss.ssssss±hh:mm | ||||||||||||||
| deliveredDate data.deliveredDate | string | 배송완료일(ISO-8601표준을 준수해야 합니다.) YYYY-MM-DDThh:mm:ss.ssssss±hh:mm | ||||||||||||||
| refer data.refer | string | 결제위치 아이폰앱,안드로이드앱,PC웹 | ||||||||||||||
| shipmentType data.shipmentType | string | 배송유형 THIRD_PARTY, CGF, CGF LITE | ||||||||||||||
| isCod data.isCod | boolean | 주문이 현금결제(착불/COD) 방식입니까 true/false
| ||||||||||||||
| ecommerceTypeCode data.ecommerceTypeCode | string | 통관 신고용 전자상거래 유형 코드. C셀러는 "A"(직접구매), A셀러는 "B"(구매대행)
| ||||||||||||||
| tradePartnerCode data.tradePartnerCode | string | 마켓플레이스 중개업체 코드. 예: "K-26-001277"
| ||||||||||||||
| tradePartnerName data.tradePartnerName | string | 마켓플레이스 중개업체명. 예: "쿠팡 주식회사"
| ||||||||||||||
| seller data.seller | object | 판매자 정보
| ||||||||||||||
| sellerName data.seller.sellerName | string | 쿠팡 마켓플레이스에 등록된 판매자명
| ||||||||||||||
| sellerId data.seller.sellerId | string | 쿠팡 마켓플레이스가 부여한 판매자 ID
| ||||||||||||||
| purchasingAgencyCode data.seller.purchasingAgencyCode | string | 조달기관 코드
| ||||||||||||||
| purchasingAgencyName data.seller.purchasingAgencyName | string | 조달기관 이름
| ||||||||||||||
| extraProperties data.extraProperties | object | 주문 속성의 기타 정보 key:value 형식세금 계산서(인보이스) 발행을 지원하는 마켓에서 다음 정보가 표시됩니다: invoiceAmountInfo:
taxReceiptInfo:receiptOption (영수증 옵션):
appliedType (적용된 유형): 세금 계산서 유형 (가능한 값):
appliedValue (적용 값): 통합 영수증 번호/정보 (가능한 값):
sameDayShipping: 주문 당일 배송 여부 (가능한 값):
cutOffTimeHour: sameDayShipping이 적용되지 않는 시간 (가능한 값):
|
Response Example
{
"code": "200",
"message": "OK",
"data": {
"shipmentBoxId": 64253897***6401429,
"orderId": 500000596,
"orderedAt": "2025-01-15T14:17:13.973885-08:00",
"orderer": {
"name": "김문근",
"email": "",
"safeNumber": "+1(555)444-1234",
"ordererNumber": null
},
"paidAt": "2025-01-15T14:17:13.973885-08:00",
"status": "FINAL_DELIVERY",
"shippingPrice": {
"currencyCode": "KRW",
"units": 2500,
"nanos": 0
},
"remotePrice": {
"currencyCode": "KRW",
"units": 0,
"nanos": 0
},
"remoteArea": false,
"parcelPrintMessage": null,
"splitShipping": false,
"ableSplitShipping": false,
"receiver": {
"name": "test",
"safeNumber": "+1(555)444-1234",
"receiverNumber": null,
"addr1": "addr1",
"addr2": "addr2",
"postCode": "284-60"
"consigneePrimaryAddress": "address based on postcode"
},
"orderItems": [
{
"sequenceNo": "001",
"vendorItemPackageId": 0,
"vendorItemPackageName": "러비더비 섬유향수 보솔레이",
"productId": 2429,
"vendorItemId": 3000000177,
"vendorItemName": "러비더비 섬유향수 보솔레이, 500ml",
"shippingCount": 1,
"salesPrice": {
"currencyCode": "KRW",
"units": 14000,
"nanos": 0
},
"orderPrice": {
"currencyCode": "KRW",
"units": 14000,
"nanos": 0
},
"discountPrice": {
"currencyCode": "KRW",
"units": 500,
"nanos": 0
},
"instantCouponDiscount": {
"currencyCode": "KRW",
"units": 0,
"nanos": 0
},
"downloadableCouponDiscount": {
"currencyCode": "KRW",
"units": 500,
"nanos": 0
},
"coupangDiscount": {
"currencyCode": "KRW",
"units": 0,
"nanos": 0
},
"externalVendorSkuCode": "800022867",
"etcInfoHeader": null,
"etcInfoValue": null,
"etcInfoValues": [
"추가메시지1",
"추가메시지2"
],
"sellerProductId": 26758514,
"sellerProductName": "[러비더비] 대용량 섬유향수 보솔레이 500ml",
"sellerProductItemName": "01_보솔레이 500ml",
"firstSellerProductItemName": "01_보솔레이 500ml",
"cancelCount": 0,
"holdCountForCancel": 0,
"estimatedShippingDate": "2017-10-12",
"plannedShippingDate": "",
"invoiceNumberUploadDate": "",
"extraProperties": {},
"pricingBadge": false,
"usedProduct": false,
"confirmDate": "2025-01-15T14:17:13.973885-08:00",
"deliveryChargeTypeName": "무료",
"productCategoryLevel1": "패션의류",
"productCategoryLevel2": "남성의류",
"productSalesPageUrl": "https://www.coupang.com/vp/products/9382706107?vendorItemId=94815759162",
"canceled": false
}
],
"overseaShippingInfoDto": {
"personalCustomsClearanceCode": null,
"ordererSsn": "",
"ordererPhoneNumber": ""
"oneTimePccc": "",
"otpNumber": null
},
"deliveryCompanyName": "CJ 대한통운",
"invoiceNumber": "337398446274",
"inTrasitDateTime": "2025-01-15T14:17:13.973885-08:00",
"deliveredDate": "2025-01-15T14:17:13.973885-08:00",
"refer": "PC웹",
"shipmentType": "CGF LITE",
"isCod": false,
ecommerceTypeCode": "A",
"tradePartnerCode": "K26001277",
"tradePartnerName": "쿠팡 주식회사",
"seller":
{
"sellerName": "TEST SELLER",
"sellerId": "C01234567",
"purchasingAgencyCode": "K26003052",
"purchasingAgencyName": "(주)뉴트리쿄스트"
},
"extraProperties": {
"invoiceAmountInfo": {
“invoiceAmountToBuyer":627,
"invoiceAmountToCoupang":0,
"currency":"TWD"
},
"taxReceiptInfo": {
"appliedValue": null,
"receiptOption": "PAPER",
"appliedType": "PERSONAL_COUPANG_MEMBER_CARRIER"
},
"sameDayShipping": "true",
"cutOffTimeHour": "18"
}
}
}# 05
에러 코드
| HTTP | 코드 | 메시지 |
|---|---|---|
| 400 | HTTP_400 | Bad Request |
오류 사양
| HTTP | 유형 | 오류 메시지 | 해결 방법 |
|---|---|---|---|
| 400 | 400 (요청변수확인) | 해당 주문이 취소 또는 반품되었습니다. | 반품/취소 요청 목록 조회 API를 통해 해당주문의 취소, 반품여부를 확인합니다. 해당 주문을 반복 호출하지 않도록 처리합니다. |
| 400 | 400 (요청변수확인) | Invalid vendor ID | 판매자ID(vendorId)를 올바로 입력했는지 확인합니다. |