端點
注意: 回應鍵可能會被修改和/或添加其他鍵。如果您將使用此端點,請設置您的代碼以適應這些可能性。
POST | https://api.iglobalstores.com/v2/orderDetail
HTTPS 請求
| 欄位↕ | 備註↕ |
|---|---|
| HTTP 方法 | POST |
| 端點 | https://api.iglobalstores.com/v2/orderDetail |
| 協議 | HTTPS |
| 訊息格式 | JSON |
| 接受 HTTP 標頭 | Accept: application/json |
| Content-Type HTTP 標頭 | Content-Type: application/json |
請求正文中的 JSON 鍵/值對
| 欄位↕ | 備註↕ |
|---|---|
orderId 可選,如果傳遞 referenceId 參數 | Zonos 訂單 Id 可以與或不與您的商店 Id 和連字符一起傳遞(示例:123-45678 或 45678)。注意:訂單完成和支付後,客戶將被重定向到您域上託管的訂單完成/訂單感謝頁面。URL 將包含查詢字符串參數 "orderId",其中包含此值。整數/字符串 |
referenceId 可選,如果傳遞 "orderId" 參數 | 此參數用於通過在 createTempCart API 服務端點中傳遞的唯一 referenceId 查找訂單數據。當打算根據 orderId 參數查找訂單詳情時,應省略此參數或將其設置為空。字符串 |
secret 必需 | Zonos 提供的 API 秘鑰 GUID。字符串 |
storeId 必需 | Zonos 提供的商店 ID。整數 |
錯誤 HTTP 回應
| 錯誤代碼↕ | 訊息↕ | 含義↕ |
|---|---|---|
| 415 | 不支持的媒體類型 | HTML 實體。HTTP "Content-Type" 標頭無效。 |
| 406 | 不可接受 | HTML 實體。HTTP "Accept" 標頭無效。 |
| 400 | 錯誤的請求 | "error":"orderId: 999-99999 不是有效的 orderId""error":"找不到 orderId 為 999-99999 的訂單""error":"無效的安全憑據""error":"無效的發佈正文""error":"需要參數 orderId 或 referenceId""error":"不能同時指定參數 orderId 和 referenceId""error":"找不到 orderId 為 999-99999 的訂單""error":"需要參數商店""error":"找不到 storeId 為 999 的 referenceId 為 999999 的訂單""error":"storeId 為 999 的 referenceId 為 999999 已重複""error":"無法使用 referenceId 999999 檢索訂單" |
| 500 | 內部服務器錯誤 | "error":"無法處理訂單詳情" |
回應 JSON 定義
| 欄位↕ | 備註↕ |
|---|---|
error | 此參數僅在發生錯誤時出現,並將包含錯誤描述。字符串 |
order | 這是訂單詳情的映射。JSON 字符串 |
order.billingZip | 訂單的帳單地址 - 這些值是在 Zonos Checkout 中輸入的。字符串 |
orderboxCount | 此欄位描述將用於運送訂單的箱子,已傳遞至 createTempCart 請求。字符串 |
order.carrierAccountNumber | 訪客自己的運輸公司帳號;當啟用訪客運輸公司帳戶時使用字符串 |
order.carrierAccountShippingMethod | 訪客自己的運輸公司帳戶上選定的運送方式;當啟用訪客運輸公司帳戶時使用字符串 |
order.cslListMatch | 綜合篩查清單 (CSL) 匹配。一個布爾值,指示客戶資訊是否在美國綜合篩查清單中產生匹配,應檢查是否存在可能的被拒政黨關聯。布爾值 |
order.customerSelectedShippingName | Zonos Checkout 內的運送選項顯示名稱字符串 |
order.dutyTaxesBreakdown | 關稅/稅款明細的映射注意 - 如果適用,IPF(國際處理費)不包括在內。JSON 字符串 |
order.dutyTaxesBreakdown.brokerageFee | 經紀費用金額(美元);正浮點數,小數點後兩位整數 |
order.dutyTaxesBreakdown.dispursementFee | 支付費用金額(美元);正浮點數,小數點後兩位整數 |
order.dutyTaxesBreakdown.duty | 關稅金額(美元);正浮點數,小數點後兩位整數 |
order.dutyTaxesBreakdown.prepaymentFee | 預付款費用金額(美元);正浮點數,小數點後兩位整數 |
order.dutyTaxesBreakdown.vatOnDispursementFee | 支付費用的增值稅/稅款金額(美元);正浮點數,小數點後兩位整數 |
order.dutyTaxesBreakdown.vatTax | 增值稅/稅款金額(美元),不包括支付費用的增值稅/稅款;正浮點數,小數點後兩位整數 |
order.dutyTaxesTotal | 關稅和稅款總額(美元);正浮點數,小數點後兩位整數 |
order.foreignCurrencyCode | 訂單支付結算的貨幣代碼。字符串 |
remittance_amount | 需要匯款到特定國家的金額,例如 _ 英國增值稅_。小數 |
order.grandTotal | 總額(美元);正浮點數,小數點後兩位整數 |
order.grandTotalForeign | 結算貨幣中的總額;正浮點數,小數點後兩位整數 |
order.items | 商品地圖列表。商品地圖包含有關在臨時購物車創建時傳遞到 Zonos Checkout 的商品的詳情。有關商品屬性的更多詳情,請查看 createTempCart API 文檔。JSON 字符串 |
order.itemsCount | 訂單行商品計數整數 |
order.itemsTotal | 商品/產品總額(美元);正浮點數,小數點後兩位整數 |
order.itemsTotalForeign | 結算貨幣中的商品/產品總額;正浮點數,小數點後兩位整數 |
order.items[index].height | 正浮點數,小數點後兩位整數 |
order.items[index].itemNonShippable | 布爾值 |
order.items[index].length | 正浮點數,小數點後兩位整數 |
order.items[index].quantity | 整數 |
order.items[index].weight | 正浮點數,小數點後兩位整數 |
order.items[index].width | 正浮點數,小數點後兩位整數 |
order.items[index].unitPrice | 正浮點數,小數點後兩位整數 |
order.merchantOrderId | 通過 updateMerchantOrderId API 服務端點與訂單關聯的 MerchantOrderId。字符串 |
order.misc1 | 通過 createTempCart API 服務端點與訂單關聯的其他值。字符串 |
order.misc2 | 通過 createTempCart API 服務端點與訂單關聯的其他值。字符串 |
order.misc3 | 通過 createTempCart API 服務端點與訂單關聯的其他值。字符串 |
order.misc4 | 通過 createTempCart API 服務端點與訂單關聯的其他值。字符串 |
order.misc5 | 通過 createTempCart API 服務端點與訂單關聯的其他值。字符串 |
order.misc6 | 通過 createTempCart API 服務端點與訂單關聯的其他值。字符串 |
order.nationalIdentifier | 當需要時,訂單的其他國際帳單地址資訊。這些值是在 Zonos Checkout 中輸入的。字符串 |
order.notes | 註釋地圖列表;註釋地圖包含有關訂單註釋的詳情。JSON 字符串 |
order.notes[index].createdByUser | 字符串 |
order.notes[index].customerNote | 一個布爾值,指示這是否是客戶創建的關於訂單、運送等的註釋。布爾值 |
order.notes[index].dateCreated | 毫秒 |
order.notes[index].dateCreatedString | 字符串 |
order.notes[index].flagged | 一個 布爾值 指示此註釋是否被標記為重要 |
order.notes[index].note | 註釋內容字符串 |
order.optInEmail | 表示客戶在 Zonos Checkout 內選擇了"註冊我們的新聞通訊"複選框。僅當您選擇在結帳頁面上顯示此複選框時適用布爾值 |
order.orderId | Zonos 系統中訂單的識別號。字符串 |
order.orderDate | 訂單創建時間戳(毫秒),採用 UTC/GMT 格式。毫秒 |
order.orderDateString | 訂單創建時間戳字符串,採用 UTC/GMT 格式。字符串 |
order.orderStatus | Zonos 系統中訂單的狀態/狀態。有關 orderStatus 使用的更多詳情,請查看 檢索訂單文檔。有關訂單狀態的其他資訊可在 更新訂單文檔 中找到。字符串 |
order.orderStatusDate | Zonos 系統中最近 orderStatus 變更的時間戳(毫秒),採用 UTC/GMT 格式。毫秒 |
order.orderStatusDateString | Zonos 系統中最近 orderStatus 變更的時間戳字符串,採用 UTC/GMT 格式。字符串 |
order.paymentProcessing | paymentProcessing 詳情的映射。某些參數可能不適用於您的帳戶,將從回應中排除。JSON 字符串 |
order.paymentProcessing.captureDate | 支付捕獲日期(毫秒),如果可用的話。如果 Zonos 正在處理支付,此節點將從回應中排除。毫秒 |
order.paymentProcessing.captureDateString | 支付捕獲日期字符串(如果可用)。如果 Zonos 正在處理支付,此節點將從回應中排除。字符串 |
order.paymentProcessing.cardType | 信用卡品牌。如果 Zonos 正在處理支付,此節點將從回應中排除。字符串 |
order.paymentProcessing.lastFour | 帳單信用卡號碼的最後四位數字。如果 Zonos 正在處理支付,此節點將從回應中排除。字符串 |
order.paymentProcessing.paymentGateway | 支付閘道名稱。如果 Zonos 正在處理支付,將表示 "iGlobal_CC" 或 "iGlobal_PayPal"。字符串 |
order.paymentProcessing.transactionType | 表示交易類型。"AUTH_CAPTURE" 或 "AUTH_ONLY"。如果 Zonos 正在處理支付,此節點將從回應中排除。字符串 |
order.poNumber | Zonos Checkout 內指定的訂單採購單號;當啟用採購單時使用字符串 |
order.quotedDutyTaxes | 在 Zonos Checkout 中報價的關稅和稅款,以美元顯示;正浮點數,小數點後兩位整數 |
order.quotedDutyTaxesForeign | 在 Zonos Checkout 中報價的關稅和稅款。以結算貨幣顯示;正浮點數,小數點後兩位整數 |
order.referenceId | 通過 createTempCart API 服務端點與訂單關聯的唯一 referenceId。字符串 |
order.shipComplete | 表示訂單是否應分多部分發運布爾值 |
order.shippingCarrierServiceLevel | 所選運送選項的運輸商和服務級別識別碼字符串 |
order.shippingInstructions | 運送服務級別的可自訂說明字符串 |
order.shippingTotal | 運費總額(美元);正浮點數,小數點後兩位 整數 |
order.shippingTotalForeign | 結算貨幣中的運費總額;正浮點數,小數點後兩位整數 |
order.testOrder | 表示訂單是否為測試訂單。布爾值 |
order.trackingNumber | 為貨物生成的追蹤號碼,如果適用的話。字符串 |
order.zip | 訂單的目的地/運送地址 - 這些值是在 Zonos Checkout 中輸入的,或通過重定向到 Zonos Checkout 的訂單中傳遞的。字符串 |
其他數據類型:
order.address1order.address2order.address3order.altPhoneorder.billingAddress1order.billingAddress2order.billingAddress3order.billingAltPhoneorder.billingCityorder.birthDateorder.billingCompanyorder.billingCountryCodeorder.billingCountryNameorder.billingEmailorder.billingNameorder.billingPhoneorder.billingStateorder.cityorder.companyorder.countryCodeorder.countryNameorder.emailorder.items[index].countryOfOriginorder.items[index].descriptionorder.items[index].imageURLorder.items[index].itemBrandorder.items[index].itemCategoryorder.items[index].itemColororder.items[index].itemCustomizationorder.items[index].itemDescriptionDetailedorder.items[index].itemDescriptionLongorder.items[index].itemFabricContentorder.items[index].itemHSCodeorder.items[index].itemLtlClassorder.items[index].itemMaterialorder.items[index].itemURLorder.items[index].productIdorder.items[index].skuorder.items[index].productIdorder.items[index].weightUnitsorder.nameorder.phoneorder.state
訂單詳情
了解訂單詳情端點的工作原理。orderDetail端點用於安全地檢索通過 Zonos Checkout 完成的訂單的詳情和狀態。