API 適用的买方用户區域:韓國、台灣
此為透過合併配送號碼(shipmentBoxId)查詢單個訂單的API。
注意:由於 CGF 訂單不會透過 Open API 返回給您,請不要使用CGF 合併配送號碼來請求,以免產生錯誤。請透過 Wing 檢視 CGF 訂單。
顧客可在付款完成後修改收貨地址,因此將商品狀態處理為“商品準備中”後,請務必透過單件訂單查詢來確認是否修改或更新了配送地資訊("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/A158000ABC/ordersheets/642538970006401429
請求引數
請求 header 除 Authorization 和 X-Requested-By 之外需要額外添加:
X-MARKET: TW
路徑引數
| 名稱 | 是否必須 | 型別 | 描述 |
| vendorId | O | String |
賣家程式碼 酷澎提供給賣家的固有程式碼 可登入Wing後檢視 |
| shipmentBoxId | O | Number |
配送編號(捆綁配送編號) 透過Wing或以分鐘/天為單位的訂單陣列查詢確認該資訊 |
請求體例子
無
返回訊息
| 名稱 | 型別 | 描述 | |||||||||||||||||
| code | Number | 伺服器返回碼 | |||||||||||||||||
| message | String | 伺服器返回訊息 | |||||||||||||||||
| data | Object | 若沒有結果,則返回空白 | |||||||||||||||||
| shipmentBoxId | Number | 合併配送號碼 | |||||||||||||||||
| orderId | Number | 訂單號碼 | |||||||||||||||||
| orderedAt | String |
訂單日期/時間 (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm |
|||||||||||||||||
| orderer | Object | 訂購人資訊 | |||||||||||||||||
| name | String | 訂購人名稱 | |||||||||||||||||
| String |
訂購人郵箱 未使用/則會顯示空值(“”) |
||||||||||||||||||
| safeNumber | String | 收貨人電話號碼(安全號碼) (格式需符合E.164標準) | |||||||||||||||||
| ordererNumber | String | 訂購人聯絡方式 (真實電話號碼) (格式需符合E.164標準) | |||||||||||||||||
| paidAt | String |
付款完成時的日期/時間 (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm |
|||||||||||||||||
| status | String |
訂單狀態
|
|||||||||||||||||
| shippingPrice | Object | 配送費 | |||||||||||||||||
| currencyCode | String | 貨幣程式碼(符合ISO-4217標準),3位大寫字元 | |||||||||||||||||
| units | Number | 貨幣整數部分,64-bit | |||||||||||||||||
| nanos | Number | 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999] | |||||||||||||||||
| remotePrice | Object | 偏遠地區運送費 | |||||||||||||||||
|
currencyCode
|
String | 貨幣程式碼(符合ISO-4217標準),3位大寫字元 | |||||||||||||||||
| units | Number | 貨幣整數部分,64-bit | |||||||||||||||||
| nanos | Number | 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999] | |||||||||||||||||
| remoteArea | Boolean | 收貨地址是否為偏遠地區 | |||||||||||||||||
| parcelPrintMessage | String | 買家備註資訊 | |||||||||||||||||
| splitShipping | Boolean | 是否為分開配送 | |||||||||||||||||
| ableSplitShipping | Boolean | 是否可以分開配送 | |||||||||||||||||
| receiver | Object |
收貨人資訊 只有訂單在付款完成狀態下買家可以更改。 請在確認訂單更改為“產品準備中”狀態時檢查收貨地址是否有改變。 |
|||||||||||||||||
| name | String | 收貨人姓名 | |||||||||||||||||
| safeNumber | String | 收貨人聯絡方式 (安全號碼) (格式需符合E.164標準) | |||||||||||||||||
| receiverNumber | String | 收貨人電話號碼 (真實號碼) (格式需符合E.164標準) | |||||||||||||||||
| addr1 | String | 收貨人地址1 | |||||||||||||||||
| addr2 | String | 收貨人地址2 | |||||||||||||||||
| postCode | String | 收貨人郵編 | |||||||||||||||||
| orderItems | Array | 訂單資訊 | |||||||||||||||||
| vendorItemPackageId | Number |
vendorItemPackageId 未使用/不存在則返回0 |
|||||||||||||||||
| vendorItemPackageName | String | vendorItemPackageName | |||||||||||||||||
| productId | Number |
產品ID 未使用/不存在則返回0 |
|||||||||||||||||
| vendorItemId | Number | 產品單項ID/OptionID | |||||||||||||||||
| vendorItemName | String | 產品顯示名稱 | |||||||||||||||||
| shippingCount | Number |
shippingCount = 訂購時的產品數量 holdCountForCancel = 被取消待退款的產品數量 |
|||||||||||||||||
| salesPrice | Object | 產品單項的價格 | |||||||||||||||||
| currencyCode | String | 貨幣程式碼(符合ISO-4217標準),3位大寫字元 | |||||||||||||||||
| units | Number | 貨幣整數部分,64-bit | |||||||||||||||||
| nanos | Number | 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999] | |||||||||||||||||
| orderPrice | Object | 付款金額: salesPrice*shippingCount | |||||||||||||||||
| currencyCode | String | 貨幣程式碼(符合ISO-4217標準),3位大寫字元 | |||||||||||||||||
| units | Number | 貨幣整數部分,64-bit | |||||||||||||||||
| nanos | Number | 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999] | |||||||||||||||||
| discountPrice | Object | 打折金額總和, discountPrice(打折金額總和) = instantCouponDiscount(立減優惠券) + downloadableCoupon(下載優惠券) + coupangDiscount(Coupang 專享優惠) |
|||||||||||||||||
| currencyCode | String | 貨幣程式碼(符合ISO-4217標準),3位大寫字元 | |||||||||||||||||
| units | Number | 貨幣整數部分,64-bit | |||||||||||||||||
| nanos | Number | 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999] | |||||||||||||||||
| instantCouponDiscount | Object | 立減優惠券數額 | |||||||||||||||||
| currencyCode | String | 貨幣程式碼(符合ISO-4217標準),3位大寫字元 | |||||||||||||||||
| units | Number | 貨幣整數部分,64-bit | |||||||||||||||||
| nanos | Number | 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999] | |||||||||||||||||
| downloadableCouponDiscount | Object | 下載優惠券數額 | |||||||||||||||||
| currencyCode | String | 貨幣程式碼(符合ISO-4217標準,3位大寫字元 | |||||||||||||||||
| units | Number | 貨幣整數部分,64-bit | |||||||||||||||||
| nanos | Number | 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999] | |||||||||||||||||
| coupangDiscount | Object |
Coupang 專享優惠 酷澎專享購物車/品類折扣等金額 |
|||||||||||||||||
| currencyCode | String | 貨幣程式碼(符合ISO-4217標準),3位大寫字元 | |||||||||||||||||
| units | Number | 貨幣整數部分,64-bit | |||||||||||||||||
| nanos | Number | 貨幣小數部分,32-bit,取值範圍 [-999999999, 999999999] | |||||||||||||||||
| externalVendorSkuCode | String | 賣家產品 SKU 程式碼 | |||||||||||||||||
| etcInfoHeader | String |
各商品單項輸入項 可選輸入 |
|||||||||||||||||
| etcInfoValue | String |
各商品單項輸入項的使用者輸入值 可選輸入 此欄位存在,但是沒有任何值. 如果需要,請使用以下 etcInfoValues. |
|||||||||||||||||
| etcInfoValues | Array |
使用者產品單項各屬性輸入值陣列 可選輸入 |
|||||||||||||||||
| sellerProductId | Number | 賣家產品ID | |||||||||||||||||
| sellerProductName | String | 註冊產品名稱 | |||||||||||||||||
| sellerProductItemName | String | 產品單項名稱 | |||||||||||||||||
| firstSellerProductItemName | String | 原始註冊產品單項名稱 | |||||||||||||||||
| cancelCount | Number | 已取消產品數量 | |||||||||||||||||
| holdCountForCancel | Number | 被取消待退款的產品數量 | |||||||||||||||||
| estimatedShippingDate | String |
收到訂單後預計發貨日期 (符合ISO-8601標準) 格式: YYYY-MM-DD |
|||||||||||||||||
| plannedShippingDate | String |
計劃發貨日期(拆分發貨訂單) (符合ISO-8601標準) 格式: YYYY-MM-DD |
|||||||||||||||||
| invoiceNumberUploadDate | String |
運單號上傳日期 (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm |
|||||||||||||||||
| extraProperties | Object |
賣家商品屬性的其它資訊 key:value 型別 |
|||||||||||||||||
| pricingBadge | Boolean |
是否為最低價 true/false |
|||||||||||||||||
| usedProduct | Boolean |
是否為二手貨 true/false |
|||||||||||||||||
| confirmDate | String |
確認收貨日期時間 (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm |
|||||||||||||||||
| deliveryChargeTypeName | String |
配送收費型別 not-free, free |
|||||||||||||||||
| canceled | Boolean |
訂單是否被取消 true/false |
|||||||||||||||||
| overseaShippingInfoDto | Object | 海外運送資訊 | |||||||||||||||||
| personalCustomsClearanceCode | String | 個人海關通關碼 | |||||||||||||||||
| orderersSsn | String | 未使用 | |||||||||||||||||
| ordererPhoneNumber | String | 收貨人電話號碼 (格式需符合E.164標準) | |||||||||||||||||
| deliveryCompanyName | String |
物流配送公司名稱 CJ Logistics, Hanjin Express, etc. |
|||||||||||||||||
| invoiceNumber | String | 運單號碼 | |||||||||||||||||
| inTrasitDateTime | String |
配送日期時間 (開始運送時間) (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm |
|||||||||||||||||
| deliveredDate | String |
配送完成日期時間 (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm |
|||||||||||||||||
| refer | String |
付款裝置資訊: iPhone, Android APP 或者 PC/Mobile 網頁。 |
|||||||||||||||||
| shipmentType | String |
運送型別 THIRD_PARTY, CGF, CGF LITE |
|||||||||||||||||
| isCod | Boolean |
訂單是否為貨到付款配送 true/false |
|||||||||||||||||
| extraProperties | Object |
訂單屬性的其它資訊 key:value 型別 有發票的市場會看到以下資訊: receiptOption:
sameDayShipping:是否當日出貨(可選值): |
|||||||||||||||||
返回訊息例子
{
"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"
},
"orderItems": [
{
"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": "무료",
"canceled": false
}
],
"overseaShippingInfoDto": {
"personalCustomsClearanceCode": null,
"ordererSsn": "",
"ordererPhoneNumber": ""
},
"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,
"extraProperties": {
"taxReceiptInfo": {
"appliedValue": null,
"receiptOption": "PAPER",
"appliedType": "PERSONAL_COUPANG_MEMBER_CARRIER"
},
"sameDayShipping": "true",
"cutOffTimeHour": "18"
}
}
}錯誤程式碼
| HTTP狀態程式碼(錯誤型別) | 錯誤資訊 | 解決方案 |
| 400 (確認請求引數) | 該訂單已取消或退貨。 | 請透過退貨/取消申請陣列查詢API確認訂單是否已被取消或退貨,並確保該訂單不被重複呼叫。 |
| 400 (確認請求引數) | 賣家ID無效。 | 請確認您輸入的賣家ID(vendorld)是否正確。例】) A00012345 |
介面名稱
GET_ORDERSHEET_BY_SHIPMENTBOX