Конечный пункт
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS запрос
| Поле | Примечания |
|---|---|
| HTTP метод | POST |
| Конечный пункт | https://api.iglobalstores.com/v1/orderNumbers |
| Протокол | HTTPS |
| Формат сообщения | JSON |
| Заголовок Accept HTTP | Accept: application/json |
| Заголовок Content-Type HTTP | Content-Type: application/json |
JSON ключ/значение в теле запроса
Формат сообщения: JSON
ПРИМЕР ЗАПРОСА: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
ПРИМЕР ЗАПРОСА: sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
ПРИМЕР ЗАПРОСА: sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
ПРИМЕР ЗАПРОСА: отсутствуетMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
ПРИМЕР ЗАПРОСА: статусы
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
Определения JSON запросов
| поле | заметки |
|---|---|
missingMerchantOrderId НЕОБЯЗАТЕЛЬНО, если передается другой параметр | Этот параметр используется для запроса набора заказов за последние две недели, которые не имеют merchantOrderId. Когда merchantOrderId отправляется через конечную точку API updateMerchantOrderID, заказы больше не будут отображаться в этом запросе.boolean: true/false |
secret ОБЯЗАТЕЛЬНО | API секретный GUID, предоставленный Zonos. string |
sinceDate НЕОБЯЗАТЕЛЬНО, если передается параметр sinceOrderId. | Этот параметр используется для запроса набора заказов после определенной даты.sinceDate и sinceOrderId не могут быть отправлены одновременно.string - дата UTC/GMT; формат: yyyymmdd |
sinceOrderId НЕОБЯЗАТЕЛЬНО, если передается параметр sinceDate / throughDate | Идентификатор заказа Zonos, может быть передан с или без вашего идентификатора магазина и дефиса (пример: 123-45678 или 45678). Примечание: Этот параметр будет использоваться для запроса набора заказов после определенного заказа Zonos. sinceDate и sinceOrderId не могут быть отправлены одновременно.integer / string |
statuses НЕОБЯЗАТЕЛЬНО | Этот параметр используется для включения текущего статуса заказа и merchantOrderId в ответ. Если он присутствует в запросе, независимо от значения, он будет включать статусы.boolean: true |
store ОБЯЗАТЕЛЬНО | Идентификатор магазина, предоставленный Zonos.integer |
throughDate НЕОБЯЗАТЕЛЬНО | Этот параметр используется для запроса набора заказов в определенном диапазоне дат. Должен быть передан вместе с параметром sinceDate .string - дата UTC/GMT; формат: yyyymmdd |
HTTPS ответ
Формат сообщения: 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
26
27
28
29
30
31
32
33
34
35
36
37
{
"totalCount": 6,
"orderCount": 5,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0"
},
{
"testOrder": false,
"id": "999-99993",
"timestamp": "2015-01-01 14:50:54.0"
},
{
"testOrder": false,
"id": "999-99994",
"timestamp": "2015-01-02 20:14:01.0"
},
{
"testOrder": false,
"id": "999-99995",
"timestamp": "2015-01-02 20:57:47.0"
},
{
"testOrder": false,
"id": "999-99996",
"timestamp": "2015-01-02 22:11:40.0"
}
]
}
Пример успешного ответа с параметром 'statuses'
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
{
"totalCount": 2,
"orderCount": 1,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0",
"merchantOrderId": null,
"orderStatus": "IGLOBAL_FRAUD_REVIEW",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0",
"merchantOrderId": "abc123",
"orderStatus": "IGLOBAL_ORDER_IN_PROCESS",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
}
]
}
Пример ответа об ошибке
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
Ошибки HTTP-ответов
| Ошибка | Значение |
|---|---|
| 406 - Не приемлемо | HTML-сущность. Заголовок HTTP “Accept” недействителен. |
| 415 - Неподдерживаемый тип медиа | HTML-сущность. Заголовок HTTP “Content-Type” недействителен. |
| 200 | “error”:”не удалось разобрать ввод” |
| 200 | “error”:”orderId: 999-99999 не является действительным orderId” |
| 200 | “error”:”Параметр orderId или referenceId обязателен.” |
| 200 | “error”:”Нельзя указать оба параметра orderId и referenceId.” |
| 200 | “error”:”Не удалось обработать детали заказа.” |
| 200 | “error”:”Недействительные учетные данные безопасности” |
Определения JSON-ответа
| поле | заметки |
|---|---|
error | Этот параметр будет присутствовать в ответе только в случае возникновения ошибки и будет содержать описание причины.string |
orderCount | Общее количество активных заказов, полученных.integer |
order.testOrderCount | Общее количество тестовых заказов, полученных.integer |
orders | Список карт заказов.string |
orders[index].id | Полный Zonos идентификатор заказа, включая идентификатор магазина и дефис.string |
orders[index].merchantOrderId | MerchantOrderId, связанный с заказом через конечную точку API-сервиса updateMerchantOrderId .string |
orders[index].orderStatus | Текущий статус заказа для возможных значений.string |
orders[index].orderStatusDate | Эпоха, представляющая момент, когда статус был последний раз обновлен.integer |
orders[index].orderStatusDateString | Временная метка, представляющая момент, когда статус был последний раз обновлен в UTC/GMT.timestamp |
orders[index].testOrder | Указывает, был ли заказ “тестовым” или “активным”.boolean |
orders[index].timestamp | Временная метка, представляющая момент, когда заказ был размещен в UTC/GMT.timestamp |
totalCount | Общее количество как активных, так и тестовых заказов, полученных.integer |
Номера заказов
Узнайте, как работает конечный пункт Номера заказов.Конечный пункт
orderNumbersиспользуется для безопасного получения списка номеров заказов, завершенных через Zonos Checkout. Обычно он используется для сверки заказов, чтобы убедиться, что все заказы были импортированы на определенную дату или по номеру заказа, а также заказы в пределах диапазона дат.