属性
请求体中的 JSON 键/值对
POST https://api.iglobalstores.com/v1/createTempCart
字段 | 备注 |
---|---|
boxCount | 示例值: 22x15x15(1),8x8x4(2),32x22x14(1) 格式: 以逗号分隔的箱子尺寸和数量列表。在上面的示例中,总共有 4 个箱子。列表中的第一个箱子将是 22 英寸长,15 英寸宽,15 英寸高。该尺寸将仅使用一个箱子。将有两个尺寸为 8x8x4 英寸的箱子。如果您觉得方便,可以多次传递相同的箱子尺寸,例如:“22x15x15(1),22x15x15(1)”,这意味着 2 个尺寸为 22x15x15 英寸的箱子。此字段描述将用于发货的箱子。预计商家在下订单时并不知道这一点;但是,如果已知,可以以 string 格式传递。 |
contShoppingURL | 此字段用于传递一个 URL,以覆盖 Zonos Checkout 内“继续购物”按钮的 HREF。 string |
domesticShippingCharge | 此字段用于传递给 Zonos Checkout 的国内运费,金额将添加到运费中。可以配置为添加运费总额或作为单独的项目列出。 正浮点数,两位小数 |
externalConfirmationPageURL | 此字段用于传递您的订单确认/感谢页面的 URL。在客户在 Zonos Checkout 内完成付款后,他们将被重定向到此 URL 以确认订单。此 URL 通常用于触发对 Zonos “orderDetail” API 服务端点的调用,以检索订单详细信息并将订单导入系统。 string |
footerHTML | 此字段用于传递一个 URL 编码的 HTML 字符串。此 HTML 字符串将在 checkout 页面关闭 body 标签之前解码并放置。通常用于传递再营销、分析等代码。 URL 编码字符串 |
items 必填 | 此字段是一个商品映射列表。 JSON 字符串 |
items[index].countryOfOrigin | 此字段用于传递商品的原产国。参数必须是国家 两字母 ISO 代码。 string |
items[index].description 必填 | 此字段用于传递购物车行项目的完整商品描述,包括任何商品选项、颜色等。 string |
items[index].height | 此字段用于传递商品高度,强烈建议提供以获得准确的运费报价。高度单位 必填 string - 正浮点数,两位小数 / 整数(英寸) |
items[index].imageURL 必填 | 此字段用于传递商品产品图像的 URL。该 URL 必须为 HTTPS,以便在 Zonos Checkout 内显示。 string / HTTPS URL |
items[index]itemBrand | 此字段用于传递商品品牌 string |
items[index]itemCategory | 此字段用于传递商品类别,如果商品有多个类别,可以使用管道分隔。 示例值: “shoes” 或 “shoes|sport-shoes|discount-shoes” string |
items[index]itemCustomization | 此字段用于传递有关商品的附加细节,这些细节在Zonos Checkout中未显示;但是,可以通过“orderDetail”API服务端点检索。 |
items[index]itemHSCode | 此字段用于传递商品的HS编码,可以带有或不带有句点。 示例值: “3926901000” 或 “3926.90.1000” string |
items[index].itemURL | 此字段用于传递商品产品页面的URL。 string / URL |
items[index].length | 此字段用于传递商品长度,强烈建议提供以获得准确的运费报价。长度单位为 必填 string - 正浮点数,保留两位小数 / 整数(英寸) |
items[index].nonShippable | 此字段用于指示商品是否应包含在运费、关税和税费计算中。数字下载、折扣码、处理费用等应传递值为“true”。 boolean: true 或 false |
items[index].productId | 此字段用于传递商品行项目的数量。 string |
items[index].quantity 必填 | 此字段用于传递商品行项目的数量。 string |
items[index].sku | 此字段用于传递商品SKU / UPC / 等等。 string |
items[index].unitPrice 必填 | 此字段用于传递商品行项目的单价。 正浮点数,保留两位小数 / 整数 |
items[index].weight | 此字段用于传递商品重量,强烈建议提供以获得准确的运费报价。重量单位默认为“LBS”,除非在items[index].itemWeightUnits 中传递了其他重量单位。string - 正浮点数,保留两位小数 / 整数 |
items[index].weightUnits | 此字段用于覆盖默认的商品重量单位。商品重量单位默认为“LBS”,除非在此字段中传递了其他重量单位。 string - "LB", "OZ", "KG", 或 "G” |
items[index].width | 此字段用于传递商品宽度,强烈建议提供以获得准确的运费报价。宽度单位为 必填 string - 正浮点数,保留两位小数 / 整数(英寸) |
misc1 - misc6 | 此字段用于通过Zonos API传递与订单相关的杂项数据,以便与从Zonos “orderDetail” API服务端点返回的订单数据一起检索。 string |
referenceId | 此字段用于传递您系统中购物车/会话等的唯一参考识别值。可以通过Zonos “orderDetail” API服务端点查找Zonos订单ID。 string |
storeId 必填 | 由Zonos提供的商店ID。 integer |
其他字符串数据类型
items[index].itemDescriptionLong
items[index].itemDescriptionDetailed
items[index].itemFabricContent
items[index].itemColor
items[index].itemLtlClass
items[index].status
items[index].itemMaterial
折扣、优惠券和促销代码
要通过服务器POST将折扣、优惠券和促销代码发送到Zonos,必须将其作为单独的项目传递,并为参数:“unitPrice”和“nonShippable”:true传递负值。
示例折扣项目映射
1
2
3
4
5
6
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
HTTPS 响应
成功的 HTTP 响应
消息格式: JSON
示例成功响应
1
2
3
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
响应 JSON 定义
字段 | 备注 |
---|---|
tempCartUUID | 此参数将包含分配给您客户国际购物车的 GUID,并在 Zonos 系统中创建。此字段将在重定向用户浏览器到 Zonos Checkout 时通过 URL 查询 string 参数传递。 |
错误 HTTP 响应
错误代码 | 含义 |
---|---|
400 | 请求体中出现意外字符。 |
406 | 不可接受。HTTP 头中的“Accept”无效。 |
415 | 不支持的媒体类型。HTTP 头中的“Content-Type”无效。 |
422 | 无法处理的实体。 |
500 | “storeId”不正确或 JSON 主体无法解析。 |
示例错误响应
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<title>Error 422 Unprocessable Entity</title>
</head>
<body>
<h2>HTTP ERROR 422</h2>
<p>
Problem accessing /v2/createTempCart. Reason:
<pre>Unprocessable Entity</pre>
</p>
<h2>The request entity had the following errors:</h2>
<ul>
<li>items may not be empty (was null)</li>
<li>items may not be null (was null)</li>
</ul>
</body>
</html>
重定向到Zonos Checkout
在收到包含tempCartUUID
的成功响应后,您的服务器将从客户的浏览器重定向到Zonos Checkout,并附上下面所述的适当的URL查询字符串参数。
示例重定向URL: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
注意: [yourassignedsubdomain] - 联系您的Zonos实施团队成员以获取您的Zonos.com子域名。
URL请求参数
字段 | 备注 |
---|---|
tempCartUUID 必填 | 此值通过调用Zonos createTempCart API服务端点获得。string / GUID |
country | 目的地国家两字母ISO代码。我们强烈建议传递此参数以提升用户体验。country 参数将在Zonos Checkout中预选目的地国家。当在网站上使用Zonos Hello JS(JavaScript)时,您可以通过调用JavaScript方法:zonos.country() 来获取此值。string (长度:2) |
其他字符串数据类型
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
创建 checkout
探索创建 checkout 中涉及的键/值对。
此 API 端点用于将购物车信息和商品从客户的购物车发送到 Zonos API。
您将收到一个 JSON 响应,其中包含
tempCartUUID
,这是 Zonos 系统中的唯一购物车标识符。此标识符将用于将客户重定向到 Zonos Checkout 以完成订单。