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 将包含一个 querystring 参数"orderId",其中包含此值。integer / string
referenceId 可选,如果传递"orderId"参数
此参数用于通过在 createTempCart API 服务端点中传递的唯一 referenceId 来查找订单的数据。当打算根据 orderId 参数查找订单详情时,应该省略此参数或将其设置为 null。string
secret 必需
Zonos 提供的 API 密钥 GUIDstring
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。stringorder.misc1stringorder.misc2stringorder.misc3stringorder.misc4stringorder.misc5stringorder.misc6stringorder.nationalIdentifierstringorder.notesJSON stringorder.notes[index].createdByUserstringorder.notes[index].customerNotebooleanorder.notes[index].dateCreatedmillisorder.notes[index].dateCreatedStringstringorder.notes[index].flaggedboolean,指示此注释是否被标记为重要order.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。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这个页面有帮助吗?