DOCS

Order details

/
Checkout•
主页API 参考 Checkout REST API 订单详细信息

订单详细信息

了解订单详细信息端点的工作原理。

orderDetail 端点用于安全地检索通过 Zonos Checkout 完成的订单的详细信息和状态。

端点 

注意： 响应键可能会被修改和/或添加额外的键。如果您将使用该端点，请设置您的代码以适应这些可能性。

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

HTTPS 请求

字段备注
HTTP 方法POST
端点https://api.iglobalstores.com/v2/orderDetail
协议HTTPS
消息格式JSON
接受 HTTP 头Accept: application/json
内容类型 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 秘密 GUIDstring
storeId 必需由 Zonos 提供的商店 ID。integer

错误 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”:”参数 store 是必需的”“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正浮点数，保留两位小数integer
order.items[index].width正浮点数，保留两位小数integer
order.items[index].unitPrice正浮点数，保留两位小数integer
order.merchantOrderId与订单关联的MerchantOrderId通updateMerchantOrderIdAPI服务端点。string
order.misc1通createTempCartAPI服务端点与订单关联的附加值。string
order.misc2通createTempCartAPI服务端点与订单关联的附加值。string
order.misc3通createTempCartAPI服务端点与订单关联的附加值。string
order.misc4通createTempCartAPI服务端点与订单关联的附加值。string
order.misc5通createTempCartAPI服务端点与订单关联的附加值。string
order.misc6通createTempCartAPI服务端点与订单关联的附加值。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中选择了“注册我们的新闻通讯”复选框，仅在您选择在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.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.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.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

这个页面有帮助吗？

有问题吗？

联系我们。
© 2024 Zonoszonos.com
在本页上：