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"
訂單詳細資訊
訂單詳細資訊
了解訂單詳細資訊端點的運作方式。orderDetail端點用於安全地取得透過 Zonos Checkout 完成的訂單的訂單詳細資訊和狀態。端點
POST |
https://api.iglobalstores.com/v2/orderDetailHTTPS 請求
https://api.iglobalstores.com/v2/orderDetail請求本體中的 JSON 金鑰/值對
orderId可選,若傳遞referenceId參數integer / stringreferenceId可選,若傳遞 "orderId" 參數createTempCartAPI 服務端點中傳遞的唯一referenceId來查詢訂單的資料。當打算根據orderId參數查詢訂單詳細資訊時,應省略此參數或設定為 null。stringsecret必填stringstoreId必填integer錯誤 HTTP 回應
回應 JSON 定義
errorstringorderJSON stringorder.billingZipstringorderboxCountstringorder.carrierAccountNumberstringorder.carrierAccountShippingMethodstringorder.cslListMatchbooleanorder.customerSelectedShippingNamestringorder.dutyTaxesBreakdownJSON stringorder.dutyTaxesBreakdown.brokerageFeeintegerorder.dutyTaxesBreakdown.dispursementFeeintegerorder.dutyTaxesBreakdown.dutyintegerorder.dutyTaxesBreakdown.prepaymentFeeintegerorder.dutyTaxesBreakdown.vatOnDispursementFeeintegerorder.dutyTaxesBreakdown.vatTaxintegerorder.dutyTaxesTotalintegerorder.foreignCurrencyCodestringremittance_amountdecimalorder.grandTotalintegerorder.grandTotalForeignintegerorder.itemsJSON stringorder.itemsCountintegerorder.itemsTotalintegerorder.itemsTotalForeignintegerorder.items[index].heightintegerorder.items[index].itemNonShippablebooleanorder.items[index].lengthintegerorder.items[index].quantityintegerorder.items[index].weightintegerorder.items[index].widthintegerorder.items[index].unitPriceintegerorder.merchantOrderIdMerchantOrderId,透過 updateMerchantOrderId API 服務端點。stringorder.misc1stringorder.misc2stringorder.misc3stringorder.misc4stringorder.misc5stringorder.misc6stringorder.nationalIdentifierstringorder.notesJSON stringorder.notes[index].createdByUserstringorder.notes[index].customerNotebooleanorder.notes[index].dateCreatedmillisorder.notes[index].dateCreatedStringstringorder.notes[index].flaggedbooleanorder.notes[index].notestringorder.optInEmailbooleanorder.orderIdstringorder.orderDatemillisorder.orderDateStringstringorder.orderStatusorderStatus使用的更多詳細資訊,請查閱「在此取得訂單文件」。訂單狀態的其他資訊可在「在此更新訂單文件」中找到。stringorder.orderStatusDateorderStatus變更的時間戳記(毫秒),UTC/GMT 格式。millisorder.orderStatusDateStringorderStatus變更的時間戳記字串,UTC/GMT 格式。stringorder.paymentProcessingpaymentProcessing詳細資訊的對應。某些參數可能不適用於您的帳戶,將從回應中排除。JSON stringorder.paymentProcessing.captureDatemillisorder.paymentProcessing.captureDateStringstringorder.paymentProcessing.cardTypestringorder.paymentProcessing.lastFourstringorder.paymentProcessing.paymentGatewaystringorder.paymentProcessing.transactionTypestringorder.poNumberstringorder.quotedDutyTaxesintegerorder.quotedDutyTaxesForeignintegerorder.referenceIdreferenceId,透過 createTempCart API 服務端點。stringorder.shipCompletebooleanorder.shippingCarrierServiceLevelstringorder.shippingInstructionsstringorder.shippingTotalintegerorder.shippingTotalForeignintegerorder.testOrderbooleanorder.trackingNumberstringorder.zipstring其他資料型別:
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這個頁面有幫助嗎?