/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/ordersheets/{shipmentBoxId}/history2609170000檢視訂單配送狀態歷史記錄
簡介
檢視訂單配送狀態歷史記錄
詳細內容
API 適用的买方用户區域:韓國、台灣
檢視特定訂單的配送狀態歷史記錄。
路徑
GET
/v2/providers/openapi/apis/api/v5/vendors/{vendorId}/ordersheets/{shipmentBoxId}/history
例子
請求 header 除 Authorization 和 X-Requested-By 之外需要額外添加:
X-MARKET: TW
請求路徑引數
| 名稱 | 是否必須 | 資料型別 | 描述 |
|---|---|---|---|
| vendorId | O | String | 賣家ID 酷澎分配給賣家的固有程式碼 e.g. A00012345 |
| shipmentBoxId | O | Number | 合併配送號碼 透過“訂單陣列檢視API”確認 |
請求體例子
無
返回訊息
| 名稱 | 資料型別 | 描述 | ||
|---|---|---|---|---|
| code | Number | 伺服器響應程式碼 | ||
| message | String | 伺服器響應資訊 | ||
| data | Array | 結算完成陣列 | ||
| shipmentBoxId | Number | 捆綁配送號碼 | ||
| details | Array | 詳細歷史記錄 | ||
| deliveryStatus | String | 配送狀態 | ||
| 引數名 | 狀態 | |||
| ACCEPT | 結算完成 | |||
| INSTRUCT | 商品準備中 | |||
| DEPARTURE | 待配送 | |||
| DELIVERING | 待配送 | |||
| FINAL_DELIVERY | 結算完成 | |||
| NONE_TRACKING | 賣家直接配送(請使用配送對接),無法追蹤 | |||
| deliveryStatusDesc | String | 配送狀態說明 | ||
| updatedAt | String | 變更時間 (符合ISO-8601標準) 格式: YYYY-MM-DDThh:mm:ss.ssssss±hh:mm |
返回訊息例子
{
"shipmentBoxId": 123456789012345678,
"data": [
{
"deliveryStatus": "FINAL_DELIVERY",
"deliveryStatusDesc": "배송완료",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
},
{
"deliveryStatus": "DELIVERING",
"deliveryStatusDesc": "배송중",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
},
{
"deliveryStatus": "DEPARTURE",
"deliveryStatusDesc": "배송지시",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
},
{
"deliveryStatus": "INSTRUCT",
"deliveryStatusDesc": "상품준비중",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
},
{
"deliveryStatus": "ACCEPT",
"deliveryStatusDesc": "결제완료",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
}
]
}
錯誤程式碼
| HTTP狀態程式碼 (錯誤型別) | 錯誤資訊 | 解決方案 |
|---|---|---|
| 400 (check request variable) | 無效賣家ID | 檢視輸入的賣家ID (vendorId)值是否正確。 |
| 500 (check request variable) | 內部異常 | 檢視輸入的捆綁配送號碼(shipmentBoxId)是否正確。 |
介面名稱
GET_ORDERSHEET_HISTORY
路徑
範例端點
https://api-gateway.coupang.com/v2/providers/openapi/apis/api/v5/vendors/A00012345/ordersheets/{shipmentBoxId}/historyPath 參數
| Name | Type | Description |
|---|---|---|
| vendorId* | string | vendorId
|
| shipmentBoxId* | string | shipmentBoxId
|
回應內容
回應訊息
| Name | Type | Description |
|---|---|---|
| code | number | 伺服器響應程式碼
|
| message | string | 伺服器響應資訊
|
| data | object[] | 結算完成陣列
|
| shipmentBoxId data[].shipmentBoxId | number | 捆綁配送號碼
|
| details data[].details | object[] | 詳細歷史記錄
|
| deliveryStatus data[].details[].deliveryStatus | string | 配送狀態
|
| 引數名 data[].引數名 | string | |
| ACCEPT | string | 結算完成
|
| INSTRUCT | string | 商品準備中
|
| DEPARTURE | string | 待配送
|
| DELIVERING | string | 待配送
|
| FINAL_DELIVERY | string | 結算完成
|
| NONE_TRACKING | string | 賣家直接配送(請使用配送對接),無法追蹤
|
NONE_TRACKING. | object | |
| deliveryStatusDesc NONE_TRACKING..deliveryStatusDesc | string | 配送狀態說明
|
| updatedAt NONE_TRACKING..updatedAt | string |
Response Example
{
"shipmentBoxId": 123456789012345680,
"data": [
{
"deliveryStatus": "FINAL_DELIVERY",
"deliveryStatusDesc": "배송완료",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
},
{
"deliveryStatus": "DELIVERING",
"deliveryStatusDesc": "배송중",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
},
{
"deliveryStatus": "DEPARTURE",
"deliveryStatusDesc": "배송지시",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
},
{
"deliveryStatus": "INSTRUCT",
"deliveryStatusDesc": "상품준비중",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
},
{
"deliveryStatus": "ACCEPT",
"deliveryStatusDesc": "결제완료",
"updatedAt": "2025-01-15T14:17:13.973885-08:00"
}
]
}錯誤碼
| HTTP | 代碼 | 訊息 |
|---|---|---|
| 400 | HTTP_400 | Bad Request |
錯誤說明
| HTTP | 類型 | 錯誤訊息 | 解決方案 |
|---|---|---|---|
| 400 | 400 (check request variable) | 無效賣家ID | 檢視輸入的賣家ID (vendorId)值是否正確。 |
| 500 | 500 (check request variable) | 內部異常 | 檢視輸入的捆綁配送號碼(shipmentBoxId)是否正確。 |