端點
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 | 狀態上次更新時的 Epoch。integer |
orders[index].orderStatusDateString | 狀態上次以 UTC/GMT 更新時的時間戳。timestamp |
orders[index].testOrder | 表示訂單是「測試訂單」還是「即時訂單」。boolean |
orders[index].timestamp | 以 UTC/GMT 表示訂單下單時的時間戳。timestamp |
totalCount | 檢索的即時和測試訂單的總計數。integer |
訂單編號
了解訂單編號端點如何運作。orderNumbers端點用於安全地檢索透過 Zonos Checkout 完成的訂單編號清單。通常用於訂單對帳，以確保所有訂單已按日期或 orderID 導入，以及查詢日期範圍內的訂單。