属性
リクエストボディ内のJSONキー/バリューペア
POST https://api.iglobalstores.com/v1/createTempCart
フィールド | ノート |
---|---|
boxCount | 例の値: 22x15x15(1),8x8x4(2),32x22x14(1) フォーマット: 箱の寸法と数のカンマ区切りリスト。上記の例では、合計で4つの箱があります。リストの最初の箱は、長さ22インチ、幅15インチ、高さ15インチです。そのサイズの箱は1つだけ使用されます。サイズ8x8x4インチの箱が2つあります。同じ箱の寸法を複数回渡すことは許可されています。例えば、「22x15x15(1),22x15x15(1)」のように、これはサイズ22x15x15インチの箱が2つあることを意味します。このフィールドは、注文を発送するために使用される箱を説明します。商人が注文時にこれを知っていることは期待されていませんが、もし知っている場合は、 string 形式で渡すことができます。 |
contShoppingURL | このフィールドは、Zonos Checkout内の「ショッピングを続ける」ボタンのHREFを上書きするためのURLを渡すために使用されます。 string |
domesticShippingCharge | このフィールドは、Zonos Checkoutに国内送料を渡すために使用され、金額は送料に加算されます。これは、送料合計を追加するように設定することも、別の行項目として分けることもできます。 positive floating point, two decimal places |
externalConfirmationPageURL | このフィールドは、注文確認/サンキューページのURLを渡すために使用されます。顧客がZonos Checkout内で支払いを完了すると、彼らはこのURLにリダイレクトされて注文確認を行います。このURLは、Zonosの「orderDetail」APIサービスエンドポイントを呼び出して、注文の詳細を取得し、システムに注文をインポートするために頻繁に使用されます。 string |
footerHTML | このフィールドは、URLエンコードされたHTML文字列を渡すために使用されます。このHTML文字列はデコードされ、checkoutページの閉じるボディタグの前に配置されます。再マーケティング、分析などのコードを渡すために一般的に使用されます。 URL encoded string |
items 必須 | このフィールドは、アイテムマップのリストです。 JSON string |
items[index].countryOfOrigin | このフィールドは、アイテムの原産国を渡すために使用されます。パラメータは国の 二文字ISOコードでなければなりません。 string |
items[index].description 必須 | このフィールドは、カートの行アイテムの完全なアイテム説明を渡すために使用され、アイテムオプション、色などを含みます。 string |
items[index].height | このフィールドは、アイテムの高さを渡すために使用され、正確な送料見積もりのために強く推奨されます。高さの単位は 必須 string - positive floating point, two decimal places / integer (inches) |
items[index].imageURL 必須 | このフィールドは、アイテム製品画像へのURLを渡すために使用されます。URLはZonos Checkout内で表示するためにHTTPSでなければなりません。 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 - positive floating point, two decimal places / integer (inches) |
items[index].nonShippable | このフィールドは、アイテムが送料、関税、および税金の計算に含まれるべきかどうかを示すために使用されます。デジタルダウンロード、割引コード、手数料などは “true” の値で渡す必要があります。 boolean: true or false |
items[index].productId | このフィールドはラインアイテムの数量を渡すために使用されます。 string |
items[index].quantity 必須 | このフィールドはラインアイテムの数量を渡すために使用されます。 string |
items[index].sku | このフィールドはアイテムのSKU / UPC / その他を渡すために使用されます。 string |
items[index].unitPrice 必須 | このフィールドはラインアイテムの単価を渡すために使用されます。 positive floating point, two decimal places / integer |
items[index].weight | このフィールドはアイテムの重量を渡すために使用され、正確な送料見積もりのために強く推奨されます。重量の単位は、他の重量単位が items[index].itemWeightUnits に渡されない限り、デフォルトで “LBS” になります。string - positive floating point, two decimal places / integer |
items[index].weightUnits | このフィールドはデフォルトのアイテム重量単位を上書きするために使用されます。アイテム重量単位は、他の重量単位がこのフィールドに渡されない限り、デフォルトで “LBS” になります。 string - "LB", "OZ", "KG", or "G” |
items[index].width | このフィールドはアイテムの幅を渡すために使用され、正確な送料見積もりのために強く推奨されます。幅の単位は 必須 string - positive floating point, two decimal places / integer (inches) |
misc1 - misc6 | このフィールドは、Zonos API を通じて注文に関連する雑多なデータを渡すために使用され、Zonos “orderDetail” API サービスエンドポイントから返される注文データと共に取得されます。 string |
referenceId | このフィールドは、システム内のカート/セッション/etc. に対する一意の参照識別値を渡すために使用されます。これは、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
割引、クーポン、およびプロモーションコード
割引、クーポン、およびプロモーションコードを 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.com サブドメインを受け取るには、Zonos の実装チームメンバーに連絡してください。
URLリクエストパラメータ
フィールド | ノート |
---|---|
tempCartUUID 必須 | この値は Zonos の createTempCart APIサービスエンドポイントを呼び出すことで取得されます。 string / GUID |
country | 目的地の国の 2文字の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に送信するために使用されます。
あなたは、Zonosシステム内の一意のカート識別子である
tempCartUUID
を含むJSONレスポンスを受け取ります。これは、顧客をZonos Checkoutにリダイレクトして、注文を完了するために使用されます。