Атрибуты
Пары ключ/значение 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 на странице оформления покупки. Обычно используется для передачи кода для переназначения, аналитики и т. д. 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 | Это поле используется для передачи категории товара и может быть передано разделённым вертикальной чертой, если товар имеет более одной категории. Примеры значений: "обувь" или "обувь|спортивная обувь|скидки на обувь" 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 или 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 сервиса Zonos "orderDetail". string |
referenceId | Это поле используется для передачи уникального значения идентификации ссылки для корзины / сеанса / и т. д. в вашей системе. Это может быть использовано для поиска ID заказа Zonos через конечный API сервиса Zonos "orderDetail". string |
storeId ТРЕБУЕТСЯ | ID магазина, предоставленный Zonos. integer |
Дополнительные типы данных string
items[index].itemDescriptionLongitems[index].itemDescriptionDetaileditems[index].itemFabricContentitems[index].itemColoritems[index].itemLtlClassitems[index].statusitems[index].itemMaterial
Скидки, купоны и промокоды
Для отправки скидок, купонов и промокодов в Zonos через серверную передачу они должны быть переданы в виде отдельного товара с отрицательным значением для параметров: "unitPrice" и "nonShippable":true.
1
{2
"description": "Discount (10OFF) - 10% OFF",3
"unitPrice": -15.5,4
"quantity": 1,5
"nonShippable": true6
}Ответ HTTPS
Успешный ответ HTTP
Формат сообщения: JSON
1
{2
"tempCartUUID": "826b8f22-0de6-4717-90c7-366def7d0782"3
}Определения JSON ответа
| поле↕ | примечания↕ |
|---|---|
tempCartUUID | Этот параметр будет содержать GUID, назначенный международной корзине клиента и созданный в системе Zonos. Это значение будет передано через параметр URL-запроса string при перенаправлении браузера пользователя на Zonos Checkout. |
Ответы об ошибках HTTP
| Код ошибки↕ | значение↕ |
|---|---|
| 400 | Неожиданный символ в теле запроса. |
| 406 | Неприемлемо. Заголовок HTTP "Accept" неверен. |
| 415 | Неподдерживаемый тип медиа. Заголовок HTTP "Content-Type" неверен. |
| 422 | Необработанный объект. |
| 500 | "storeId" неправилен или тело JSON не может быть разобрано. |
1
2
3
4
5
6
7
Error 422 Unprocessable Entity 8
9
10
11
12
13
HTTP ERROR 422
14
15
16
Problem accessing /v2/createTempCart. Reason:17
Unprocessable Entity
18
19
20
21
The request entity had the following errors:
22
23
24
25
items may not be empty (was null) 26
27
items may not be null (was null) 28
29
30
31
32
33
Перенаправление на 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 ТРЕБУЕТСЯ | Это значение получается путём вызова конечного API сервиса Zonos createTempCart. string / GUID |
country | Двухбуквенный код ISO страны назначения. Мы настоятельно рекомендуем передавать этот параметр для лучшего пользовательского опыта. Параметр country предварительно выберет страну назначения внутри Zonos Checkout. При использовании Zonos Hello JS (JavaScript) на сайте вы можете получить это значение, вызвав метод JavaScript: zonos.country(). string (Длина: 2) |
Дополнительные типы данных string
customerNamecustomerCompanycustomerEmailcustomerPhonecustomerAltPhonecustomerAddress1customerAddress2customerCitycustomerStatecustomerZip
Создайте заказ
Изучите ключевые пары "ключ/значение", необходимые для создания заказа.
Этот конечный API используется для отправки информации о корзине и товаров из корзины клиента в API Zonos.
Вы получите ответ JSON, содержащий
tempCartUUID, уникальный идентификатор корзины в системе Zonos. Это будет использовано для перенаправления клиента на Zonos Checkout для завершения заказа.