Endpoint orderNumbers используется для безопасного получения списка номеров заказов, завершенных через Zonos Checkout. Обычно он используется для сверки заказов, чтобы убедиться, что все заказы были импортированы на определенную дату или по идентификатору заказа, а также заказы в диапазоне дат.
POST | https://api.iglobalstores.com/v1/orderNumbers
Запрос HTTPS
Поле↕
Примечания↕
HTTP method
POST
Endpoint
https://api.iglobalstores.com/v1/orderNumbers
Protocol
HTTPS
Message format
JSON
Accept HTTP header
Accept: application/json
Content-Type HTTP header
Content-Type: application/json
JSON ключ/значение в теле запроса
Формат сообщения: JSON
1{
2"store":"999",
3"secret":"f5bde245-f55e-414d-b722-80b25161c12c",
4"sinceOrderId":"999-99999"
5}
Определения JSON запроса
Поле↕
Примечания↕
missingMerchantOrderId НЕОБЯЗАТЕЛЬНО, если передается другой параметр
Этот параметр используется для запроса набора заказов за последние две недели, в которых отсутствует merchantOrderId. Когда merchantOrderId отправляется через endpoint API updateMerchantOrderID, заказы больше не будут отображаться в этом запросе.boolean: true/false
secret ОБЯЗАТЕЛЬНО
API-ключ GUID, предоставленный Zonos. string
sinceDate НЕОБЯЗАТЕЛЬНО, если передается параметр sinceOrderId.
Этот параметр используется для запроса набора заказов после определенной даты.sinceDate и sinceOrderId не могут быть отправлены одновременно.string - дата UTC/GMT; формат: yyyymmdd
sinceOrderId НЕОБЯЗАТЕЛЬНО, если передаются параметры sinceDate / throughDate
ID заказа Zonos, может быть передан с вашим ID магазина и дефисом или без них (Пример: 123-45678 или 45678).Примечание: Этот параметр будет использован для запроса набора заказов после определенного заказа Zonos. sinceDate и sinceOrderId не могут быть отправлены одновременно.integer / string
statuses НЕОБЯЗАТЕЛЬНО
Этот параметр используется для включения текущего статуса заказа и merchantOrderId в ответ. Если он присутствует в запросе, независимо от значения, он будет включен в статусы.boolean: true
store ОБЯЗАТЕЛЬНО
ID магазина, предоставленный Zonos.integer
throughDate НЕОБЯЗАТЕЛЬНО
Этот параметр используется для запроса набора заказов в определенном диапазоне дат.Должен быть передан вместе с параметром sinceDate.string - дата UTC/GMT; формат: yyyymmdd
Ответ HTTPS
Формат сообщения: JSON
1{
2"totalCount":6,
3"orderCount":5,
4"testOrderCount":1,
5"orders":[
6{
7"testOrder":false,
8"id":"999-99991",
9"timestamp":"2015-01-01 00:33:14.0"
10},
11{
12"testOrder":true,
13"id":"999-99992",
14"timestamp":"2015-01-01 05:12:46.0"
15},
16{
17"testOrder":false,
18"id":"999-99993",
19"timestamp":"2015-01-01 14:50:54.0"
20},
21{
22"testOrder":false,
23"id":"999-99994",
24"timestamp":"2015-01-02 20:14:01.0"
25},
26{
27"testOrder":false,
28"id":"999-99995",
29"timestamp":"2015-01-02 20:57:47.0"
30},
31{
32"testOrder":false,
33"id":"999-99996",
34"timestamp":"2015-01-02 22:11:40.0"
35}
36]
37}
Ошибки HTTP ответов
Ошибка↕
Значение↕
406 - Not Acceptable
HTML Entity. HTTP заголовок "Accept" недействителен.
415 - Unsupported media type
HTML Entity. HTTP заголовок "Content-Type" недействителен.
200
"error":"could not parse input"
200
"error":"orderId: 999-99999 is not a valid orderId"
200
"error":"Parameter orderId or referenceId is required."
200
"error":"Cannot specify both Parameters orderId and referenceId."
200
"error":"Could not process order details."
200
"error":"Invalid security credentials"
Определения JSON ответа
Поле↕
Примечания↕
error
Этот параметр будет присутствовать в ответе только при возникновении ошибки и будет содержать описание причины.string
orderCount
Общее количество полученных активных заказов.integer
order.testOrderCount
Общее количество полученных тестовых заказов.integer
orders
Список объектов заказов.string
orders[index].id
Полный ID заказа Zonos, включая ID магазина и дефис.string
orders[index].merchantOrderId
MerchantOrderId, связанный с заказом через endpoint 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
Номера заказов
Номера заказов
Узнайте, как работает endpoint «Номера заказов».Endpoint
orderNumbersиспользуется для безопасного получения списка номеров заказов, завершенных через Zonos Checkout. Обычно он используется для сверки заказов, чтобы убедиться, что все заказы были импортированы на определенную дату или по идентификатору заказа, а также заказы в диапазоне дат.Endpoint
POST |
https://api.iglobalstores.com/v1/orderNumbersЗапрос HTTPS
https://api.iglobalstores.com/v1/orderNumbersJSON ключ/значение в теле запроса
Формат сообщения: JSON
{"store": "999","secret": "f5bde245-f55e-414d-b722-80b25161c12c","sinceOrderId": "999-99999"}Определения JSON запроса
missingMerchantOrderIdНЕОБЯЗАТЕЛЬНО, если передается другой параметрmerchantOrderId. КогдаmerchantOrderIdотправляется через endpoint APIupdateMerchantOrderID, заказы больше не будут отображаться в этом запросе.boolean: true/falsesecretОБЯЗАТЕЛЬНОstringsinceDateНЕОБЯЗАТЕЛЬНО, если передается параметрsinceOrderId.sinceDateиsinceOrderIdне могут быть отправлены одновременно.string- дата UTC/GMT; формат:yyyymmddsinceOrderIdНЕОБЯЗАТЕЛЬНО, если передаются параметрыsinceDate/throughDatesinceDateиsinceOrderIdне могут быть отправлены одновременно.integer / stringstatusesНЕОБЯЗАТЕЛЬНОmerchantOrderIdв ответ. Если он присутствует в запросе, независимо от значения, он будет включен в статусы.boolean: truestoreОБЯЗАТЕЛЬНОintegerthroughDateНЕОБЯЗАТЕЛЬНОsinceDate.string- дата UTC/GMT; формат:yyyymmddОтвет HTTPS
Формат сообщения: JSON
{"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"}]}Ошибки HTTP ответов
Определения JSON ответа
errorstringorderCountintegerorder.testOrderCountintegerordersstringorders[index].idstringorders[index].merchantOrderIdMerchantOrderId, связанный с заказом через endpoint APIupdateMerchantOrderId.stringorders[index].orderStatusstringorders[index].orderStatusDateintegerorders[index].orderStatusDateStringtimestamporders[index].testOrderbooleanorders[index].timestamptimestamptotalCountintegerБыла ли эта страница полезной?