Атрибуты
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 для замены HREF кнопки "Продолжить покупки" внутри Zonos Checkout. string |
domesticShippingCharge | Это поле используется для передачи национальной стоимости доставки в Zonos Checkout, и сумма будет добавлена к доставке. Это можно настроить для добавления общей стоимости доставки или разделения как отдельной строки. положительное число с плавающей точкой, два знака после запятой |
externalConfirmationPageURL | Это поле используется для передачи URL вашей страницы подтверждения заказа / страницы благодарности. После того, как клиент завершит оплату внутри Zonos Checkout, его перенаправят на этот URL для подтверждения заказа. Этот URL часто используется для вызова конечной точки API-сервиса "orderDetail" Zonos для получения деталей заказа и импорта заказа в систему. string |
footerHTML | Это поле используется для передачи закодированной URL HTML строки. Эта HTML строка будет декодирована и размещена перед закрывающим тегом body на странице checkout. Обычно используется для передачи кода для ремаркетинга, аналитики и т. д. закодированная 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; однако, это можно получить через конечную точку API “orderDetail”. |
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 or 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 | Это поле используется для передачи различных данных, связанных с заказом, через API Zonos для получения вместе с данными заказа, возвращаемыми из конечной точки API “orderDetail” Zonos. string |
referenceId | Это поле используется для передачи уникального идентификационного значения для корзины/сессии и т. д. в вашей системе. Это можно использовать для поиска идентификатора заказа Zonos через конечную точку API “orderDetail” Zonos. string |
storeId ОБЯЗАТЕЛЬНО | Идентификатор магазина, предоставленный Zonos. целое число |
Дополнительные строковые типы данных
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
.
ПРИМЕР КАРТЫ СКИДКИ
{
"description": "Discount (10OFF) - 10% OFF",
"unitPrice": -15.5,
"quantity": 1,
"nonShippable": true
}
HTTPS ответ
Успешный HTTP ответ
Формат сообщения: JSON
ПРИМЕР УСПЕШНОГО ОТВЕТА
{
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"
}
Определения JSON ответа
поле | заметки |
---|---|
tempCartUUID | Этот параметр будет содержать GUID, назначенный международной корзине вашего клиента и созданный в системе Zonos. Это поле будет передано через параметр string запроса URL при перенаправлении браузера пользователя на Zonos Checkout. |
Ошибки HTTP ответов
Код ошибки | значение |
---|---|
400 | Неожиданный символ в теле запроса. |
406 | Неприемлемо. HTTP заголовок для “Accept” недействителен. |
415 | Неподдерживаемый тип медиа. HTTP заголовок для “Content-Type” недействителен. |
422 | Неперерабатываемая сущность. |
500 | “storeId” был неверным или тело JSON не удалось разобрать. |
ПРИМЕР ОТВЕТА С ОШИБКОЙ
<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 перенаправления: https://[yourassignedsubdomain].iglobalstores.com/?tempCartUUID=826b8f22-0de6-4717-90c7-366def7d0782&country=CA
Примечание: [yourassignedsubdomain] - Свяжитесь с членом вашей команды по внедрению Zonos, чтобы получить ваш поддомен Zonos.com.
Параметры запроса URL
поле | заметки |
---|---|
tempCartUUID ОБЯЗАТЕЛЬНО | Это значение получается путем вызова API-сервиса Zonos createTempCart . строка / GUID |
country | Двухбуквенный ISO код страны назначения two-letter ISO code. Мы настоятельно рекомендуем передавать этот параметр для улучшения пользовательского опыта. Параметр country предварительно выберет страну назначения внутри Zonos Checkout. При использовании Zonos Hello JS (JavaScript) на сайте вы можете получить это значение, вызвав метод JavaScript: zonos.country() . строка (Длина: 2) |
Дополнительные строковые типы данных
customerName
customerCompany
customerEmail
customerPhone
customerAltPhone
customerAddress1
customerAddress2
customerCity
customerState
customerZip
Создание checkout
Изучите ключевые пары значений, связанные с созданием checkout.
Этот конечная точка API используется для отправки информации о корзине и товарах из корзины клиента в API Zonos.
Вы получите JSON-ответ, содержащий
tempCartUUID
, уникальный идентификатор корзины в системе Zonos. Он будет использоваться для перенаправления клиента в Zonos Checkout, чтобы завершить заказ.