Точки доступа
Запросить детали завершенного заказа
POST | https://api.iglobalstores.com/2.0/order-completed - Создайте новый запрос на получение информации, связанной с завершенным заказом.
HTTPS запрос
| Поле | Примечания |
|---|---|
| HTTP метод | POST |
| URL точки доступа | https://api.iglobalstores.com/2.0/order-completed |
| Протокол | HTTPS |
| Формат сообщения | JSON |
| Заголовок Accept HTTP | Accept: application/json |
| Заголовок токена безопасности HTTP | serviceToken: your-test-token-valueДобавьте заголовок к вашему HTTPS запросу с именем serviceToken и значением вашего тестового токена безопасности API. (Свяжитесь с вашим менеджером по аккаунтам для получения этого токена.) |
| Заголовок Content-Type HTTP | Content-Type: application/jsonПоскольку вы будете отправлять данные JSON на сервис, добавьте заголовок к вашему HTTPS запросу с именем Content-Type и значением application/json |
JSON ключ/значение в теле запроса
Формат сообщения: JSON
Пример запроса
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
Определения JSON запросов
| Поле | Примечания |
|---|---|
billingAddress ОБЯЗАТЕЛЬНО | Это адрес для выставления счета по заказу. Это карта, содержащая следующие поля адреса: address1, address2, address3, city, state, stateCode, postalCode и countryCode. Эти поля могут быть обязательными или необязательными в зависимости от страны. Конечная точка локализации возвращает, какие конкретные поля адреса обязательны или нет для каждой страны. Примечание: stateCode всегда не является обязательным и не указывается в конечной точке локализации. Вы можете передать stateCode, если он доступен. |
billingCompany НЕОБЯЗАТЕЛЬНО | Это название компании для выставления счета по заказу. |
billingEmail ОБЯЗАТЕЛЬНО | Это адрес электронной почты для выставления счета по заказу. |
billingName ОБЯЗАТЕЛЬНО | Это полное имя для выставления счета по заказу. |
billingPhone ОБЯЗАТЕЛЬНО | Это номер телефона для выставления счета по заказу. |
items[index].orderGrandTotal ОБЯЗАТЕЛЬНО | Это общая сумма, уплаченная покупателем за их заказ в USD (доллары США). Пожалуйста, укажите без запятых, без знака доллара “$” и с двумя десятичными знаками. Пример значения: 2102.99 |
items[index].orderNumber ОБЯЗАТЕЛЬНО | Это ваш номер заказа для только что завершенного заказа. Пример значения: 854725421 |
paymentTypeCode ОБЯЗАТЕЛЬНО | Метод оплаты, использованный покупателем для оплаты их заказа. Примеры значений: PayPal или Visa или MC или AMEX или DISC |
prepaidDutyTax ОБЯЗАТЕЛЬНО | Выбрал ли покупатель prepay свои импортные пошлины и налоги или он был вынужден prepay их? Если да, установите значение true; если нет, установите значение false. Примеры значений: true или false |
shippingQuoteId ОБЯЗАТЕЛЬНО | Это ID предложения по доставке, которое выбрал покупатель. Детали корзины должны быть такими же, как они были, когда предложения по доставке были получены. Если детали корзины изменились, то вам следует запросить новые предложения по доставке перед завершением заказа покупателя. |
shipToCompany НЕОБЯЗАТЕЛЬНО | Это название компании лица, которое получит отправленный заказ. |
shipToEmail ОБЯЗАТЕЛЬНО | Это адрес электронной почты лица, которое получит отправленный заказ. |
shipToName ОБЯЗАТЕЛЬНО | Это полное имя лица, которое получит отправленный заказ. |
shipToPhone ОБЯЗАТЕЛЬНО | Это номер телефона лица, которое получит отправленный заказ. |
HTTPS ответ
Формат сообщения: JSON
Пример ответа только для Канады и Австралии
Примечание: Фактические ответы будут содержать все поддерживаемые страны.
Пример ответа
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Определения JSON ответа
| Поле | Примечания |
|---|---|
deniedParty | Это карта результатов проверки на наличие запрещенной стороны. Если установлено значение null, то проверка на наличие запрещенной стороны не проводилась. Свяжитесь с вашим Zonos представителем, если вы столкнетесь с этим. |
deniedParty.flagged | Указывает, совпадает ли этот заказ с записью в консолидированных списках запрещенных сторон Zonos. Если true, проверьте этот заказ перед обработкой. В случае сомнений не обрабатывайте заказ, который помечен как true. Примеры значений: true или false |
deniedParty.source | Если поле flagged установлено в true, это поле будет содержать ссылки на источники, полезные для проверки, почему заказ был помечен как совпадающий с запрещенной стороной. |
igOrderId | Zonos идентификатор для только что завершенного заказа. Пример значения: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
Завершенный заказ API Legacy
Узнайте, как работает API завершенного заказа Legacy.Точка доступа завершенного заказа принимает окончательные детали заказа покупателя, проверяет детали заказа на наличие отклоненных сторон и возвращает результаты вместе с уникальным идентификатором заказа, специфичным для Zonos.