訂單詳細資訊

了解訂單詳細資訊端點的運作方式。

orderDetail 端點用於安全地取得透過 Zonos Checkout 完成的訂單的訂單詳細資訊和狀態。

端點 

注意: 回應金鑰可能會被修改和/或添加額外的金鑰。如果您將使用此端點,請設定您的程式碼以應對這些可能性。

POST | https://api.iglobalstores.com/v2/orderDetail

HTTPS 請求

欄位說明
HTTP 方法POST
端點https://api.iglobalstores.com/v2/orderDetail
通訊協定HTTPS
訊息格式JSON
Accept HTTP 標頭Accept: application/json
Content-Type HTTP 標頭Content-Type: application/json

請求本體中的 JSON 金鑰/值對

欄位說明
orderId 可選,若傳遞 referenceId 參數Zonos 訂單 ID 可以與或不帶您的商店 ID 和連字符一起傳遞(例如:123-45678 或 45678)。注意:訂單完成和支付後,客戶將被重定向到托管在您域上的「訂單完成」/「訂單謝謝」頁面。URL 將包含查詢字串參數 "orderId",其中將包含此值。integer / string
referenceId 可選,若傳遞 "orderId" 參數此參數用於通過在 createTempCart API 服務端點中傳遞的唯一 referenceId 來查詢訂單的資料。當打算根據 orderId 參數查詢訂單詳細資訊時,應省略此參數或設定為 null。string
secret 必填由 Zonos 提供的 API 祕密 GUID。string
storeId 必填由 Zonos 提供的商店 ID。integer

錯誤 HTTP 回應

錯誤代碼訊息含義
415不支援的媒體類型HTML 實體。HTTP "Content-Type" 標頭無效。
406不可接受HTML 實體。HTTP "Accept" 標頭無效。
400不當請求"error":"orderId: 999-99999 is not a valid orderId""error":"Could not find an order with orderId: 999-99999""error":"Invalid security credentials""error":"Invalid post body""error":"Parameter orderId or referenceId is required""error":"Cannot specify both Parameters orderId and referenceId""error":"No order found with orderId: 999-99999""error":"Parameter store required""error":"No order found with referenceId: 999999 for storeId: 999""error":"referenceId: 999999 for storeId: 999 has been duplicated""error":"Couldn't retrieve order with referenceId: 999999"
500內部伺服器錯誤"error":"Couldn't process order details"

回應 JSON 定義

欄位說明
error此參數僅在發生錯誤時出現,將包含錯誤說明。string
order這是訂單詳細資訊的對應。JSON string
order.billingZip訂單的帳單地址 - 值已輸入 Zonos Checkout。string
orderboxCount此欄位說明將用於運送訂單的紙箱,傳遞到 createTempCart 請求。string
order.carrierAccountNumber訪客自己的運輸承運商帳號;在啟用訪客承運商帳戶時使用。string
order.carrierAccountShippingMethod訪客自己的運輸承運商帳戶上選定的運送方法;在啟用訪客承運商帳戶時使用。string
order.cslListMatch綜合篩選清單 (CSL) 符合。一個布林值,表示客戶資訊何時在美國綜合篩選清單中產生符合,應被審查以確定可能的拒絕方關聯。boolean
order.customerSelectedShippingNameZonos Checkout 內的運送選項顯示名稱。string
order.dutyTaxesBreakdown稅金/關稅明細的對應。注意 - 如果適用,IPF(國際處理費)不包括在內。JSON string
order.dutyTaxesBreakdown.brokerageFee經紀費金額(美元);正浮點數,小數點後兩位。integer
order.dutyTaxesBreakdown.dispursementFee支付費金額(美元);正浮點數,小數點後兩位。integer
order.dutyTaxesBreakdown.duty關稅金額(美元);正浮點數,小數點後兩位。integer
order.dutyTaxesBreakdown.prepaymentFee預付費金額(美元);正浮點數,小數點後兩位。integer
order.dutyTaxesBreakdown.vatOnDispursementFee支付費上的 VAT/稅金額(美元);正浮點數,小數點後兩位。integer
order.dutyTaxesBreakdown.vatTaxVAT/稅金額(美元),不包括支付費上的 VAT/稅金;正浮點數,小數點後兩位。integer
order.dutyTaxesTotal關稅和稅金總額(美元);正浮點數,小數點後兩位。integer
order.foreignCurrencyCode訂單付款結算所用的貨幣代碼。string
remittance_amount需要匯款至特定國家的金額,例如,_ UK VAT_。decimal
order.grandTotal總計(美元);正浮點數,小數點後兩位。integer
order.grandTotalForeign結算貨幣中的總計;正浮點數,小數點後兩位。integer
order.items項目對應的清單。項目對應包含臨時購物車建立時傳遞至 Zonos Checkout 的項目詳細資訊。如需更多有關項目屬性的詳細資訊,請查閱 createTempCart API 文件。JSON string
order.itemsCount訂單行項目計數。integer
order.itemsTotal項目/產品總計(美元);正浮點數,小數點後兩位。integer
order.itemsTotalForeign結算貨幣中的項目/產品總計;正浮點數,小數點後兩位。integer
order.items[index].height正浮點數,小數點後兩位。integer
order.items[index].itemNonShippableboolean
order.items[index].length正浮點數,小數點後兩位。integer
order.items[index].quantityinteger
order.items[index].weight正浮點數,小數點後兩位。integer
order.items[index].width正浮點數,小數點後兩位。integer
order.items[index].unitPrice正浮點數,小數點後兩位。integer
order.merchantOrderId與訂單關聯的 MerchantOrderId,透過 updateMerchantOrderId API 服務端點。string
order.misc1與訂單關聯的其他值,透過 createTempCart API 服務端點。string
order.misc2與訂單關聯的其他值,透過 createTempCart API 服務端點。string
order.misc3與訂單關聯的其他值,透過 createTempCart API 服務端點。string
order.misc4與訂單關聯的其他值,透過 createTempCart API 服務端點。string
order.misc5與訂單關聯的其他值,透過 createTempCart API 服務端點。string
order.misc6與訂單關聯的其他值,透過 createTempCart API 服務端點。string
order.nationalIdentifier訂單所需的額外國際帳單地址資訊。值已輸入 Zonos Checkout。string
order.notes注意事項對應的清單;注意事項對應包含訂單、運送等相關注意事項詳細資訊。JSON string
order.notes[index].createdByUserstring
order.notes[index].customerNote布林值,表示這是否為客戶建立的有關訂單、運送等的注意事項。boolean
order.notes[index].dateCreatedmillis
order.notes[index].dateCreatedStringstring
order.notes[index].flagged布林值,表示此注意事項是否被標記為重要。boolean
order.notes[index].note注意事項內容。string
order.optInEmail指示客戶在 Zonos Checkout 內選擇了「註冊我們的電子報」複選框。僅在您選擇在結帳頁面上顯示此複選框時適用。boolean
order.orderIdZonos 系統中訂單的識別號碼。string
order.orderDate以 UTC/GMT 為單位的訂單建立時間戳記(毫秒)。millis
order.orderDateString以 UTC/GMT 為單位的訂單建立時間戳記字串。string
order.orderStatusZonos 系統中訂單的狀態/狀態。如需有關 orderStatus 使用的更多詳細資訊,請查閱「在此取得訂單文件」。訂單狀態的其他資訊可在「在此更新訂單文件」中找到。string
order.orderStatusDateZonos 系統中最近 orderStatus 變更的時間戳記(毫秒),UTC/GMT 格式。millis
order.orderStatusDateStringZonos 系統中最近 orderStatus 變更的時間戳記字串,UTC/GMT 格式。string
order.paymentProcessingpaymentProcessing 詳細資訊的對應。某些參數可能不適用於您的帳戶,將從回應中排除。JSON string
order.paymentProcessing.captureDate支付捕獲的日期(毫秒),如果有的話。如果 Zonos 正在處理支付,此節點將從回應中排除。millis
order.paymentProcessing.captureDateString支付捕獲的日期(字串),如果有的話。如果 Zonos 正在處理支付,此節點將從回應中排除。string
order.paymentProcessing.cardType信用卡品牌。如果 Zonos 正在處理支付,此節點將從回應中排除。string
order.paymentProcessing.lastFour帳單信用卡號碼的最後四位數字。如果 Zonos 正在處理支付,此節點將從回應中排除。string
order.paymentProcessing.paymentGateway支付閘道名稱。如果 Zonos 正在處理支付,將顯示「iGlobal_CC」或「iGlobal_PayPal」。string
order.paymentProcessing.transactionType表示交易類型「AUTH_CAPTURE」或「AUTH_ONLY」。如果 Zonos 正在處理支付,此節點將從回應中排除。string
order.poNumberZonos Checkout 內指定的訂單採購單編號;在啟用採購單時使用。string
order.quotedDutyTaxesZonos Checkout 中引用的關稅和稅金,以美元顯示;正浮點數,小數點後兩位。integer
order.quotedDutyTaxesForeignZonos Checkout 中引用的關稅和稅金。以結算貨幣顯示;正浮點數,小數點後兩位。integer
order.referenceId與訂單關聯的唯一 referenceId,透過 createTempCart API 服務端點。string
order.shipComplete指示訂單是否應分多個部分運送。boolean
order.shippingCarrierServiceLevel所選運送選項的承運商和服務等級識別碼。string
order.shippingInstructions運送服務等級的可自訂說明。string
order.shippingTotal運送總計(美元);正浮點數,小數點後兩位。integer
order.shippingTotalForeign結算貨幣中的運送總計;正浮點數,小數點後兩位。integer
order.testOrder指示訂單是否為測試訂單。boolean
order.trackingNumber為出貨產生的追蹤號碼(如適用)。string
order.zip訂單的目的地/運送地址 - 值已輸入 Zonos Checkout 或已透過重定向至 Zonos Checkout 傳遞至訂單。string

其他資料型別:

  • order.address1
  • order.address2
  • order.address3
  • order.altPhone
  • order.billingAddress1
  • order.billingAddress2
  • order.billingAddress3
  • order.billingAltPhone
  • order.billingCity
  • order.birthDate
  • order.billingCompany
  • order.billingCountryCode
  • order.billingCountryName
  • order.billingEmail
  • order.billingName
  • order.billingPhone
  • order.billingState
  • order.city
  • order.company
  • order.countryCode
  • order.countryName
  • order.email
  • order.items[index].countryOfOrigin
  • order.items[index].description
  • order.items[index].imageURL
  • order.items[index].itemBrand
  • order.items[index].itemCategory
  • order.items[index].itemColor
  • order.items[index].itemCustomization
  • order.items[index].itemDescriptionDetailed
  • order.items[index].itemDescriptionLong
  • order.items[index].itemFabricContent
  • order.items[index].itemHSCode
  • order.items[index].itemLtlClass
  • order.items[index].itemMaterial
  • order.items[index].itemURL
  • order.items[index].productId
  • order.items[index].sku
  • order.items[index].productId
  • order.items[index].weightUnits
  • order.name
  • order.phone
  • order.state