端点
注意: 响应键可能会被修改和/或添加额外的键。如果您将使用此端点,请设置您的代码以适应这些可能性。
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" |
| 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.customerSelectedShippingName | Zonos 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 | 支付费上的增值税/税款金额,美元;正浮点数,两位小数integer |
order.dutyTaxesBreakdown.vatTax | 增值税/税款金额,美元,不包括支付费上的增值税/税款;正浮点数,两位小数integer |
order.dutyTaxesTotal | 关税和税款总计,美元;正浮点数,两位小数integer |
order.foreignCurrencyCode | 订单付款结算的货币代码。string |
remittance_amount | 需要汇款到特定国家的金额,例如英国增值税。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].itemNonShippable | boolean |
order.items[index].length | 正浮点数,两位小数integer |
order.items[index].quantity | integer |
order.items[index].weight | 正浮点数,两位小数integer |
order.items[index].width | 正浮点数,两位小数integer |
order.items[index].unitPrice | 正浮点数,两位小数integer |
order.merchantOrderId | 与通过 updateMerchantOrderId API 服务端点的订单关联的 MerchantOrderId。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].createdByUser | string |
order.notes[index].customerNote | 一个布尔值,指示这是否是客户创建的关于订单、运送等的注释。boolean |
order.notes[index].dateCreated | millis |
order.notes[index].dateCreatedString | string |
order.notes[index].flagged | 一个 boolean,指示此注释是否被标记为重要 |
order.notes[index].note | 注释内容string |
order.optInEmail | 指示客户选中了 Zonos Checkout 内部的"注册我们的新闻通讯"复选框。仅当您选择在结账页面上显示此复选框时适用boolean |
order.orderId | Zonos 系统中订单的识别号string |
order.orderDate | 订单创建的时间戳(以毫秒为单位),UTC/GMT。millis |
order.orderDateString | 订单创建的时间戳字符串,UTC/GMT。string |
order.orderStatus | Zonos 系统中订单的状态/状态。有关 orderStatus 使用的更多详情,请查看 检索订单文档。有关订单状态的其他信息,请参见 更新订单文档。string |
order.orderStatusDate | Zonos 系统中最近一次 orderStatus 变更的时间戳(以毫秒为单位),UTC/GMT。millis |
order.orderStatusDateString | Zonos 系统中最近一次 orderStatus 变更的时间戳字符串,UTC/GMT。string |
order.paymentProcessing | paymentProcessing 详情的地图。某些参数可能不适用于您的账户,将从响应中排除。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.poNumber | Zonos Checkout 中指定的订单采购订单号;在启用采购订单时使用string |
order.quotedDutyTaxes | Zonos Checkout 中报价的关税和税款,以美元显示;正浮点数,两位小数integer |
order.quotedDutyTaxesForeign | Zonos Checkout 中报价的关税和税款。以结算货币显示;正浮点数,两位小数integer |
order.referenceId | 通过 createTempCart API 服务端点与订单关联的唯一 referenceId。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.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 完成的订单的详情和状态。