端點
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS 請求
| 欄位↕ | 注意事項↕ |
|---|---|
| HTTP 方法 | POST |
| 端點 | https://api.iglobalstores.com/v1/orderNumbers |
| 通訊協定 | HTTPS |
| 訊息格式 | JSON |
| Accept HTTP 標頭 | Accept: application/json |
| Content-Type HTTP 標頭 | Content-Type: application/json |
請求主體中的 JSON 鍵/值
訊息格式：JSON
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"sinceOrderId": "999-99999"5
}請求 JSON 定義
| 欄位↕ | 注意事項↕ |
|---|---|
missingMerchantOrderId 選填，如果傳遞另一個參數選項 | 此參數用於查詢過去兩週內缺少 merchantOrderId 的訂單集合。當通過 updateMerchantOrderID API 端點提交 merchantOrderId 時，訂單將不再顯示在此查詢中。boolean: true/false |
secret 必填 | Zonos 提供的 API 密鑰 GUID。string |
sinceDate 選填，如果傳遞 sinceOrderId 參數 | 此參數用於查詢特定日期後的訂單集合。sinceDate 和 sinceOrderId 不能同時發送。string - 日期 UTC/GMT；格式：yyyymmdd |
sinceOrderId 選填，如果傳遞 sinceDate / throughDate 參數 | Zonos 訂單 ID，可以使用或不使用您的商店 ID 和連字符進行傳遞（範例：123-45678 或 45678）。注意：此參數將用於查詢特定 Zonos 訂單之後的訂單集合。sinceDate 和 sinceOrderId 不能同時發送。integer / string |
statuses 選填 | 此參數用於在回應中包含目前訂單狀態和 merchantOrderId。如果在請求中出現，無論值為何，都將包含狀態。boolean: true |
store 必填 | Zonos 提供的商店 ID。integer |
throughDate 選填 | 此參數用於查詢特定日期範圍內的訂單集合。必須與 sinceDate 參數一起傳遞。string - 日期 UTC/GMT；格式：yyyymmdd |
HTTPS 回應
訊息格式：JSON
1
{2
"totalCount": 6,3
"orderCount": 5,4
"testOrderCount": 1,5
"orders": [6
{7
"testOrder": false,8
"id": "999-99991",9
"timestamp": "2015-01-01 00:33:14.0"10
},11
{12
"testOrder": true,13
"id": "999-99992",14
"timestamp": "2015-01-01 05:12:46.0"15
},16
{17
"testOrder": false,18
"id": "999-99993",19
"timestamp": "2015-01-01 14:50:54.0"20
},21
{22
"testOrder": false,23
"id": "999-99994",24
"timestamp": "2015-01-02 20:14:01.0"25
},26
{27
"testOrder": false,28
"id": "999-99995",29
"timestamp": "2015-01-02 20:57:47.0"30
},31
{32
"testOrder": false,33
"id": "999-99996",34
"timestamp": "2015-01-02 22:11:40.0"35
}36
]37
}錯誤 HTTP 回應
| 錯誤↕ | 含義↕ |
|---|---|
| 406 - Not Acceptable | HTML 實體。HTTP "Accept" 標頭無效。 |
| 415 - Unsupported media type | HTML 實體。HTTP "Content-Type" 標頭無效。 |
| 200 | "error":"could not parse input" |
| 200 | "error":"orderId: 999-99999 is not a valid orderId" |
| 200 | "error":"Parameter orderId or referenceId is required." |
| 200 | "error":"Cannot specify both Parameters orderId and referenceId." |
| 200 | "error":"Could not process order details." |
| 200 | "error":"Invalid security credentials" |
回應 JSON 定義
| 欄位↕ | 注意事項↕ |
|---|---|
error | 此參數僅在發生錯誤時出現在回應中，並包含原因的說明。string |
orderCount | 檢索的即時訂單總計數。integer |
order.testOrderCount | 檢索的測試訂單總計數。integer |
orders | 訂單映射列表。string |
orders[index].id | 完整的 Zonos 訂單 ID，包括商店 ID 和連字符。string |
orders[index].merchantOrderId | 通過 updateMerchantOrderId API 服務端點與訂單關聯的 MerchantOrderId。string |
orders[index].orderStatus | 訂單的目前狀態，可能的值。string |
orders[index].orderStatusDate | 代表狀態最後更新時間的紀元。integer |
orders[index].orderStatusDateString | 代表狀態最後更新時間的時間戳，採用 UTC/GMT 格式。timestamp |
orders[index].testOrder | 指示訂單是「測試訂單」還是「即時訂單」。boolean |
orders[index].timestamp | 代表訂單下達時間的時間戳，採用 UTC/GMT 格式。timestamp |
totalCount | 檢索的即時訂單和測試訂單總計數。integer |
訂單號碼
了解訂單號碼端點如何運作。orderNumbers端點用於安全地檢索通過 Zonos Checkout 完成的訂單號碼列表。通常用於訂單協調，以確保所有訂單已導入至特定日期或訂單 ID，以及特定日期範圍內的訂單。