GET
/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/ordersheets/{shipmentBoxId}2609170000查詢單個訂單(合併配送號碼)
# 01
簡介
查詢單個訂單(合併配送號碼)
# 02
詳細內容
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# 03
Path 參數
| Name | Type | Description |
|---|---|---|
| vendorId* | string | 賣家程式碼 酷澎提供給賣家的固有程式碼 可登入Wing後檢視 |
| shipmentBoxId* | number | 配送編號(捆綁配送編號) 透過Wing或以分鐘/天為單位的訂單陣列查詢確認該資訊 |
# 04
回應內容
回應訊息
| Name | Type | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | number | 伺服器返回碼
| ||||||||||||||
| message | string | 伺服器返回訊息
| ||||||||||||||
| data | object | 若沒有結果,則返回空白
| ||||||||||||||
| shipmentBoxId data.shipmentBoxId | number | 合併配送號碼
| ||||||||||||||
| orderId data.orderId | number | 訂單號碼
| ||||||||||||||
| orderedAt data.orderedAt | string | |||||||||||||||
| orderer data.orderer | object | 訂購人資訊
| ||||||||||||||
| name data.orderer.name | string | 訂購人名稱
| ||||||||||||||
| email data.orderer.email | string | 訂購人郵箱 未使用/則會顯示空值(“”) | ||||||||||||||
| safeNumber data.orderer.safeNumber | string | 收貨人電話號碼(安全號碼) (格式需符合E.164標準)
| ||||||||||||||
| ordererNumber data.orderer.ordererNumber | string | 訂購人聯絡方式 (真實電話號碼) (格式需符合E.164標準)
| ||||||||||||||
| paidAt data.paidAt | string | |||||||||||||||
| 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,取值範圍 [-999999999, 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,取值範圍 [-999999999, 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標準)
| ||||||||||||||
| 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/OptionID
| ||||||||||||||
| vendorItemName data.orderItems[].vendorItemName | string | 產品顯示名稱
| ||||||||||||||
| shippingCount data.orderItems[].shippingCount | number | shippingCount = 訂購時的產品數量 holdCountForCancel = 被取消待退款的產品數量 cancelCount = 已經確認要被取消的產品數量 可配送產品數量 = shippingCount - (holdCountForCancel + cancelCount ) | ||||||||||||||
| salesPrice data.orderItems[].salesPrice | object | 產品單項的價格
| ||||||||||||||
| 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,取值範圍 [-999999999, 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,取值範圍 [-999999999, 999999999]
| ||||||||||||||
| discountPrice data.orderItems[].discountPrice | object | 打折金額總和, discountPrice(打折金額總和) = instantCouponDiscount(立減優惠券) + downloadableCoupon(下載優惠券) + coupangDiscount(Coupang 專享優惠) | ||||||||||||||
| 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,取值範圍 [-999999999, 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,取值範圍 [-999999999, 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,取值範圍 [-999999999, 999999999]
| ||||||||||||||
| coupangDiscount data.orderItems[].coupangDiscount | object | Coupang 專享優惠 酷澎專享購物車/品類折扣等金額 | ||||||||||||||
| 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,取值範圍 [-999999999, 999999999]
| ||||||||||||||
| externalVendorSkuCode data.orderItems[].externalVendorSkuCode | string | 賣家產品 SKU 程式碼
| ||||||||||||||
| etcInfoHeader data.orderItems[].etcInfoHeader | string | 各商品單項輸入項 可選輸入 | ||||||||||||||
| etcInfoValue data.orderItems[].etcInfoValue | string | 各商品單項輸入項的使用者輸入值 可選輸入 此欄位存在,但是沒有任何值. 如果需要,請使用以下 etcInfoValues. | ||||||||||||||
| etcInfoValues data.orderItems[].etcInfoValues | object[] | 使用者產品單項各屬性輸入值陣列 可選輸入 | ||||||||||||||
| 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 | |||||||||||||||
| plannedShippingDate data.orderItems[].plannedShippingDate | string | |||||||||||||||
| invoiceNumberUploadDate data.orderItems[].invoiceNumberUploadDate | string | |||||||||||||||
| 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 | |||||||||||||||
| deliveryChargeTypeName data.orderItems[].deliveryChargeTypeName | string | 配送收費型別 not-free, free | ||||||||||||||
| productCategoryLevel1 data.orderItems[].productCategoryLevel1 | string | 商品分類一級類目名稱
| ||||||||||||||
| productCategoryLevel2 data.orderItems[].productCategoryLevel2 | string | 商品分類二級類目名稱
| ||||||||||||||
| productSalesPageUrl data.orderItems[].productSalesPageUrl | string | Coupang 市場商品銷售頁面 URL
| ||||||||||||||
| canceled data.orderItems[].canceled | boolean | 訂單是否被取消 true/false | ||||||||||||||
| overseaShippingInfoDto data.overseaShippingInfoDto | object | 海外運送資訊
| ||||||||||||||
| personalCustomsClearanceCode data.overseaShippingInfoDto.personalCustomsClearanceCode | string | 個人海關通關碼
| ||||||||||||||
| orderersSsn data.overseaShippingInfoDto.orderersSsn | string | 未使用
| ||||||||||||||
| ordererPhoneNumber data.overseaShippingInfoDto.ordererPhoneNumber | string | 收貨人電話號碼 (格式需符合E.164標準)
| ||||||||||||||
| oneTimePccc data.overseaShippingInfoDto.oneTimePccc | string | KCS 簽發的一次性個人通關代碼(PCCC)。用於基於 CI 認證的自購訂單
| ||||||||||||||
| otpNumber data.overseaShippingInfoDto.otpNumber | string | 通關驗證用 OTP(一次性密碼)
| ||||||||||||||
| deliveryCompanyName data.deliveryCompanyName | string | 物流配送公司名稱 CJ Logistics, Hanjin Express, etc. | ||||||||||||||
| invoiceNumber data.invoiceNumber | string | 運單號碼
| ||||||||||||||
| inTrasitDateTime data.inTrasitDateTime | string | |||||||||||||||
| deliveredDate data.deliveredDate | string | |||||||||||||||
| refer data.refer | string | 付款裝置資訊: iPhone, Android APP 或者 PC/Mobile 網頁。 | ||||||||||||||
| shipmentType data.shipmentType | string | 運送型別 THIRD_PARTY, CGF, CGF LITE | ||||||||||||||
| isCod data.isCod | boolean | 訂單是否為貨到付款配送 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 | 在 Coupang 市場註冊的賣家名稱
| ||||||||||||||
| sellerId data.seller.sellerId | string | Coupang 市場分配的賣家 ID
| ||||||||||||||
| extraProperties data.extraProperties | object | 訂單屬性的其它資訊 key:value 型別 有發票的市場會看到以下資訊: invoiceAmountInfo: invoiceAmountToBuyer:應開立予買家之發票金額 invoiceAmountToCoupang:應開立予酷澎之發票金額 currency:貨幣代碼 taxReceiptInfo: receiptOption:
-「true」:當日出貨啟用 -「false」:當日出貨停用 cutOffTimeHour:晚於此時間當日出貨不適用(可選值):
|
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"
},
"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 (確認請求引數) | 賣家ID無效。 | 請確認您輸入的賣家ID(vendorld)是否正確。例】) A00012345 |