Запрос статуса заказов
Для запроса статуса заказов необходимо сделать запрос на /v1/statusreq/ с контейнером следующего вида:
{
"statusreq": {
"auth": {
"attributes": {
"login": "test",
"pass": "test"
},
"value": false
},
"changes": {
"value": "ONLY_LAST"
}
}
}
Возможно передавать следующие элементы:
- orderno - Номер заказа. Необязательный элемент.
- ordercode - Внутренний код заказа. Необязательный элемент.
- issue_date - дата выдачи заказа.
- target - Строка поиска. Позволяет указать текст, который содержится в названии компании или адресе получателя.
-
- done - Может принимать значения:
- ONLY_DONE - Только доставленные (имеются в виду успешные статусы, например, Доставлен или Частично доставлен)
- ONLY_NOT_DONE - Только не доставленные (заказы, которые не являются доставленными, например, Не доставлен или Утерян)
- ONLY_NEW - Только новые
- ONLY_DELIVERY - Только заказы в обработке - заказы, находящиеся в любом статусе, кроме конечных: Доставлено, Не доставлено, Отменён и т.д.
- changes - может принимать значение только ONLY_LAST. Если указан этот параметр, все остальные игнорируются.
Ответ API в случае успешного запроса:
{
"statusreq": {
"attributes": {
"count": 1
},
"order": [
{
"attributes": {
"orderno": "111111",
"awb": "111111",
"orderno2": null,
"ordercode": "10142809",
"givencode": ""
},
"barcode": {
"value": "111111"
},
"route_id": {
"value": 309110
},
"sender": {
"company": {
"value": "ТЕСТ!!!!!!"
},
"person": {
"value": "Владимир"
},
"town": {
"value": "153361",
"attributes": {
"code": "153361"
}
},
"address": {
"value": "Тверская ул., 7"
},
"phone": {
"value": "8-903-002-00-76"
},
"contacts": {
"value": "8-903-002-00-76"
},
"date": {
"value": "2014-03-22"
},
"time_min": {
"value": "09:00:00"
},
"time_max": {
"value": "14:00:00"
}
},
"receiver": {
"company": {
"value": "M&M"
},
"person": {
"value": "Чипурин"
},
"phone": {
"value": "512-23-32"
},
"contacts": {
"value": "8-907-123-45-22"
},
"zipcode": {
"value": "123313"
},
"town": {
"value": "1",
"attributes": {
"regionname": "1"
}
},
"address": {
"value": "Тверская 4 офис 2"
},
"pvz": {
"code": {
"value": "321"
}
},
"date": {
"value": "2020-06-22"
},
"time_min": {
"value": "10:00:00"
},
"time_max": {
"value": "18:00:00"
},
"coords": {
"attributes": {
"lat": "",
"lon": ""
},
"value": false
},
"from_client_name": {
"value": "Алексей"
},
"from_client_position": {
"value": "менеджер"
}
},
"return": {
"value": "NO"
},
"weight": {
"value": "2.1"
},
"return_weight": {
"value": "2.1"
},
"quantity": {
"value": "2"
},
"acceptpartially": {
"value": "Да"
},
"paytype": {
"value": "CASH"
},
"service": {
"value": "2"
},
"return_service": {
"value": "1"
},
"type": {
"value": "3"
},
"return_type": {
"value": "3"
},
"waittime": {
"value": false
},
"price": {
"value": "400.0"
},
"inshprice": {
"value": "400.0"
},
"enclosure": {
"value": "Детские игрушки"
},
"instruction": {
"value": "Проверить при покупателе, подписать акт"
},
"currcoords": {
"value": false,
"attributes": {
"lat": "",
"lon": ""
},
"accuracy": {
"lon": ""
},
"RequestDateTime": {
"lon": ""
}
},
"courier": {
"code": {
"value": false
},
"name": {
"value": false
},
"phone": {
"value": false
}
},
"deliveryprice": {
"attributes": {
"total": 150,
"delivery": "150",
"return": "0"
}
},
"receiverpays": {
"value": "NO"
},
"addresschanged": {
"value": false
},
"status": {
"value": "NEWPICKUP",
"attributes": {
"id": "38010932",
"eventstore": "офис в Москве",
"eventtime": "2020-09-08 09:48:28",
"createtimegmt": "2020-09-08 12:48:28",
"message": null,
"title": "Создан забор"
}
},
"statushistory": {
"status": [
{
"value": "NEW",
"attributes": {
"id": "38010513",
"eventstore": "Web-службы",
"eventtime": "2020-09-08 09:35:53",
"createtimegmt": "2020-09-08 12:35:53",
"message": "",
"title": "Новый"
}
},
{
"value": "NEWPICKUP",
"attributes": {
"id": "38010932",
"eventstore": "офис в Москве",
"eventtime": "2020-09-08 09:48:28",
"createtimegmt": "2020-09-08 12:48:28",
"message": "",
"title": "Создан забор"
}
}
]
},
"customstatecode": {
"value": "1"
},
"deliveredto": {
"value": false
},
"delivereddate": {
"value": false
},
"deliveredtime": {
"value": false
},
"outstrbarcode": {
"value": false
}
}
]
}
}
"statusreq": {
"attributes": {
"count": 300
},
Поле count в элементе attributes у корневого элемента statusreq означает сколько заказов подходят под критерии выборки
Далее в массиве order перечисляются данные заказов, попавших под условия выборки, описание элементов в выборке:
"barcode": {
"value": false
},
Штрихкод (поле "номер" в карточке товара)
"route_id": {
"value": 309110
},
ID маршрута из метода "setroute" (необязательное поле)
"sender": {
"company": {
"value": "ТЕСТ!!!!!!"
},
"person": {
"value": "Владимир"
},
"town": {
"value": "153361",
"attributes": {
"code": "153361"
}
},
"address": {
"value": "Тверская ул., 7"
},
"phone": {
"value": "8-903-002-00-76"
},
"contacts": {
"value": "8-903-002-00-76"
},
"date": {
"value": "2014-03-22"
},
"time_min": {
"value": "09:00:00"
},
"time_max": {
"value": "14:00:00"
}
},
Элемент sender содержит информацию об отправителе, его содержимое:
- company - компания отправитель
- person - имя отправителя
- town - город отправления, атрибут code код города
- address - адрес отправления
- phone - телефон отправителя
- contacts - содержит контакты отправителя
- date - дата отправления
- time_min - начало промежутка отправленя
- time_max - конец промежутка отправленя
"receiver": {
"company": {
"value": "M&M"
},
"person": {
"value": "Чипурин"
},
"phone": {
"value": "512-23-32"
},
"contacts": {
"value": "8-907-123-45-22"
},
"zipcode": {
"value": "123313"
},
"town": {
"value": "1",
"attributes": {
"regionname": "1"
}
},
"address": {
"value": "Тверская 4 офис 2"
},
"pvz": {
"code": {
"value": "321"
}
},
"date": {
"value": "2020-06-22"
},
"time_min": {
"value": "10:00:00"
},
"time_max": {
"value": "18:00:00"
},
"coords": {
"attributes": {
"lat": "",
"lon": ""
},
"value": false
},
"from_client_name": {
"value": "Алексей"
},
"from_client_position": {
"value": "менеджер"
}
},
Элемент receiver содержит информацию о получателе, его содержимое:
- company - компания получатель
- person - имя получателя
- town - город получателя, атрибут code код города
- phone - телефон получателя
- contacts - содержит контакты получателя
- zipcode - почтовый индекс
- address - адрес получателя
- pvz - номер ПВЗ для получения заказа
- date - дата доставки
- time_min - начало промежутка доставки
- time_max - конец промежутка доставки
- coords - содержит атрибуты lat - широту и lon - долготу
- from_client_name - имя человека принявшего заказ (необязательное поле)
- from_client_position - должность человека принявшего заказ (необязательное поле)
"return": {
"value": "NO"
},
return был ли возврат
"weight": {
"value": false
},
weight общий вес отправления
"return_weight": {
"value": false
},
return_weight общий вес возврата позиций отправления
"quantity": {
"value": 2
},
quantity общее количество позиций в отправлении
"acceptpartially": {
"value": "Да"
},
acceptpartially доступен ли частичный выкуп (Да/Нет)
"paytype": {
"value": "CASH"
},
paytype тип оплаты
- CASH - наличными
- CARD - безнал
"price": {
"value": 400
},
price цена доставки
"inshprice": {
"value": 400
},
inshprice объявленная стоимость
"enclosure": {
"value": "Детские игрушки"
},
enclosure вложение (комментарий)
"enclosure": {
"value": "Проверить при покупателе, подписать акт"
},
instruction инструкции для курьера
"currcoords": {
"value": false,
"attributes": {
"lat": "",
"lon": ""
}
},
currcoordsтекущие координаты заказа с атрибутами lat и lon
"courier": {
"code": {
"value": false
},
"name": {
"value": false
},
"phone": {
"value": false
}
},
courier с вложенными элементами code - внутренний id курьера в системе, name - имя курьера, phone - телефон курьера
"deliveryprice": {
"attributes": {
"total": 150,
"delivery": "150",
"return": "0"
}
},
deliveryprice
"items": {
"value": false,
"item": [
{
"value": "Смартфон ASUS ZenFone 3 ZE520KL 32GB золотистый",
"attributes": {
"code": "14763309",
"extcode": "",
"quantity": "1",
"mass": "1.1",
"length": "0",
"width": "0",
"height": "0",
"retprice": "0",
"VATrate": "10",
"barcode": "a909c650b3d04b0a7685219c608409a0b04fce5fc713f91586",
"origincountry": "0",
"returns": "0"
}
}
]
},
items содержит элемент item, представляющий из себя массив со элементов, содержащих информацию о содержимом заказа, в поле value передается название позиции, в атрибутах передаются следующие значения:
- code - внутренний id позиции в системе
- extcode - код при интеграции
- quantity - количество
- mass - масса единицы
- length - длин
- width - ширина
- height - высота
- retprice - цена продажи
- VATrate - ставка НДС для этой позиции
- barcode - штрихкод
- origincountry - страна производтва
- returns - количество данного товара, от которого отказался получатель
"receiverpays": {
"value": "NO"
},
receiverpays оплата на месте
"addresschanged": {
"value": false
},
addresschanged был ли изменен человеком адрес доставки
"status": {
"attributes": {
"id": "56697805",
"eventstore": "офис в Москве",
"eventtime": "2022-07-07 14:44:12",
"createtimegmt": "2022-07-07 11:44:12",
"UTCzerotime": "2022-07-07T11:44:12Z",
"UTCtime": "2022-07-07T14:44:12+03:00",
"message": null,
"title": "Производится таможенный контроль"
},
"value": "CUSTOMSPROCESS"
},
status текущий статус заказа, в поле value текстовое название статуса, в атрибутах передаются следующие значения:
- id - внутренний id статуса в системе
- eventstore - филиал, к которому относится текущий статус
- eventtime - время события по часовому поясу места его наступления
- createtimegmt - время по GMT создания записи о смене статуса в БД
- UTCzerotime - время UTC 0 создания записи о смене статуса в БД
- UTCtime - время по UTC со смещением (по стандарту ISO 8601) создания записи о смене статуса в БД
- message - наименование филиала-получателя, при передаче между филиалами
- title - русское наименование статуса
- reasonId - ID причины отказа доставки (статус COURIERCANCELED), текст причины содержится в "message", необязательный атрибут
statushistory содержит элемент status, представляющий из себя массив со элементов, содержащих информацию об истории статусов заказа, содержимое идентично элементу status
"customstatecode": {
"value": "1"
},
customstatecode статус заказа
"deliveredto": {
"value": false
},
deliveredto комментарий
"delivereddate": {
"value": false
},
delivereddate дата доставки
"deliveredtime": {
"value": false
},
deliveredtime время доставки
"outstrbarcode": {
"value": false
},
outstrbarcode штрих код в случае получения заказа от партнеров