Поиск по сайту

API
Главная / API - Поиск заказов

Поиск заказов

Обновлено 17.02.2020
274 кб

Общие сведения

Сервис позволяет получать актуальную информацию о заказах.

Для идентификации состава ответа используется входящий параметр "request.sessionID". Если в запросе присутствует параметр, то в ответе будут переданы подробные данные, если нет - краткая информация. Таким образом, подробная информация по заказам доступна только для авторизованных пользователей. 

Поиск заказов

Запрос метода

Пример запроса

Адрес метода: https://api.dellin.ru/v3/orders.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "docIds":[
      "19-00085281151",
      "19-00085281152"
   ],
   "orderNumber":"1234567889",
   "orderDate":"2019-11-02",
   "barcode":"1345678",
   "dateStart":"2019-11-11 10:10",
   "dateEnd":"2019-11-12 10:10",
   "states":"pickup",
   "page":1,
   "lastUpdate":"2019-11-12 10:10",
   "orderDatesExtended":true,
   "orderBy":"ordered_at"
}

Адрес метода: https://api.dellin.ru/v3/orders.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>A00000000-0000-0000-0000-000000000000</sessionID>
   <docIds>19-00085281151</docIds>
   <docIds>19-00085281152</docIds>
   <orderNumber>1234567889</orderNumber>
   <orderDate>2019-11-02</orderDate>
   <barcode>1345678</barcode>
   <dateStart>2019-11-11 10:10</dateStart>
   <dateEnd>2019-11-12 10:10</dateEnd>
   <states>pickup</states>
   <page>1</page>
   <lastUpdate>2019-11-12 10:10</lastUpdate>
   <orderDatesExtended>true</orderDatesExtended>
   <orderBy>ordered_at</orderBy>
</request>

Описание параметров

Request
Request
ПараметрОбязательныйТипОписание
appKeyДаstringКлюч приложения. Для получения ключа необходимо пройти регистрацию

sessionID

Нет*string

ID сессии. Для получения сессии необходимо воспользоваться сервисом "Авторизация пользователя".

*Если запрос содержит параметр, то в ответе будут переданы подробные данные, если нет - краткая информация

docIdsНет*array of string

Номер заказа, накладной или заявки. Возможна передача нескольких параметров. Максимум может быть передано 5 значений.

*Параметр используется для поиска заказа. Если в запросе отсутствует параметр "sessionID", то в нём должен присутствовать один из следующих параметров: "docid", "barcode" или "orderNumber"

В запросе может быть передан только один из параметров: "docid", "barcode", "orderNumber"
orderNumberНет*string

Номер заказа интернет-магазина (внутренний номер заказа, ВНЗ).

*Параметр используется для поиска заказа. Если в запросе отсутствует параметр "sessionID", то в нём должен присутствовать один из следующих параметров: "docid", "barcode" или "orderNumber"

В запросе может быть передан только один из параметров: "docid", "barcode", "orderNumber"
orderDateНетstring

Дата заказа интернет-магазина.

Формат: "ГГГГ-ММ-ДД"

barcode

Нет*string

Штрих-код документа, считанный сканером штрих-кодов.

Длина поля - 25 символов. Первые 3 символа определяют вид документа:

  • 128 - накладная;
  • 415 - заявка на доставку (только предзаказ).

*Параметр используется для поиска заказа. Если в запросе отсутствует параметр "sessionID", то в нём должен присутствовать один из следующих параметров: "docid", "barcode" или "orderNumber"

В запросе может быть передан только один из параметров: "docid", "barcode", "orderNumber"
dateStartНетstring

Начальная дата и время периода (для фильтрации результатов поиска по периоду создания заказа).

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС".

Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docid", "barcode" или "orderNumber"

dateEndНетstring

Конечная дата и время периода (для фильтрации результатов поиска по периоду создания заказа. Учитывается при указании параметра "dateStart").

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС".

Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docid", "barcode" или "orderNumber"

statesНетarray of string

Список статусов, заказы с которыми надо получить в ответе. Статусы указываются на основании "Справочника статусов заказа груза".

Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docid", "barcode" или "orderNumber"

pageНетintegerНомер запрашиваемой страницы ответа
lastUpdateНетstring

Фильтр для поиска заказов, изменившихся в период, начиная с указанного в данном параметре момента времени.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС".

Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docid", "barcode" или "orderNumber"

orderByНетstring

Сортировка заказов.

Возможные значения:

  • ordered_at - по дате заказа;
  • updated_at - по дате обновления.

Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docid", "barcode" или "orderNumber"

Ответ метода

Пример ответа

{
   "metadata":{
      "status":200,
      "currentPage":1,
      "nextPage":null,
      "prevPage":null,
      "totalPages":1,
      "generatedAt":"2019-11-11 12:50:20"
   },
   "orders":[
      {
         "orderNumber":null,
         "orderDate":null,
         "orderId":"39513109",
         "orderedAt":"2019-11-11 08:16:36",
         "state":"processing",
         "stateName":"В обработке",
         "stateDate":null,
         "derival":{
            "city":"г. Москва",
            "cityId":3,
            "cityCode":"7700000000000000000000000",
            "address":"г. Москва, Загорьевский проезд, д. 4",
            "addressCode":null,
            "terminalName":"Москва Север 2",
            "terminalAddress":"127411, Москва г, Лобненская ул, дом № 18, стр 2",
            "terminalId":36
         },
         "arrival":{
            "city":"Омск г (Омская обл.)",
            "cityId":43,
            "cityCode":"5500000100000000000000000",
            "address":"Омск г (Омская обл.), 22 Партсъезда ул, д. 4",
            "addressCode":null,
            "terminalName":"Омск",
            "terminalAddress":"644031, Омская обл, Омск г, Омская ул, дом № 221",
            "terminalId":53,
            "terminalCity":"Омск",
            "terminalCoordinates":[
               73.4417,
               54.9939
            ],
            "terminalEmail":"pismo@dellin.ru ",
            "terminalPhones":"7 (3812) 45-45-45",
            "callCenterPhones":"8-800-100-8000",
            "terminalWorktables":{
               "sun":"24 ч",
               "mon":"24 ч",
               "tue":"24 ч",
               "wed":"24 ч",
               "thu":"24 ч",
               "fri":"24 ч",
               "sat":"24 ч"
            }
         },
         "sender":{
            "opf":null,
            "opfUid":null,
            "name":"APIRequestPositiveSender",
            "address":"г. Москва, Загорьевский проезд, д. 4",
            "isPhysical":null,
            "inn":null,
            "documentType":null,
            "documentSeries":null,
            "documentNumber":null,
            "counteragentUid":null,
            "contacts":"contact",
            "phones":"89136665588"
         },
         "receiver":{
            "opf":null,
            "opfUid":null,
            "name":"APIRequestPositiveReceiver",
            "address":"Омск г (Омская обл.), 22 Партсъезда ул, д. 4",
            "isPhysical":null,
            "inn":null,
            "documentType":null,
            "documentSeries":null,
            "documentNumber":null,
            "counteragentUid":null,
            "anonym":false,
            "anonymPhone":null,
            "anonymEmail":null
         },
         "payer":{
            "opf":null,
            "opfUid":null,
            "name":"APIRequestPositiveSender",
            "isPhysical":null,
            "inn":null,
            "documentType":null,
            "documentSeries":null,
            "documentNumber":null,
            "counteragentUid":null
         },
         "freight":{
            "name":"Мебельная фурнитура",
            "weight":"0.1",
            "oversizedWeight":null,
            "volume":"0.1",
            "oversizedVolume":null,
            "places":1,
            "oversizedPlaces":null,
            "length":"0.1",
            "width":"0.1",
            "height":"0.1"
         },
         "isAir":false,
         "air":{

         },
         "locks":[

         ],
         "totalSum":0.0,
         "isPaid":true,
         "isPreorder":false,
         "produceDate":"2019-11-20",
         "declineReason":null,
         "orderDates":{
            "arrivalToOspReceiver":"2019-11-27",
            "arrivalToOspReceiverMax":null,
            "arrivalToOspReceiverAccdoc":null,
            "arrivalToOspSender":null,
            "arrivalToReceiver":null,
            "declineDate":null,
            "derivalFromOspReceiver":"2019-11-27 00:00:00",
            "derivalFromOspReceiverMax":null,
            "derivalFromOspReceiverAccdoc":null,
            "giveoutFromOspReceiver":null,
            "giveoutFromOspReceiverMax":null,
            "derivalFromOspSender":"2019-11-22 00:00:00",
            "draftLastUpdate":null,
            "finish":null,
            "firstDocumentCreatedDate":null,
            "pickup":"2019-11-20 00:00:00",
            "processingDate":"2019-11-11",
            "warehousing":null
         },
         "orderTimeInDays":{
            "delivery":null,
            "deliveryAccdoc":null
         },
         "orderedDeliveryFromAddress":true,
         "availableDeliveryFromAddress":false,
         "orderedDeliveryToAddress":true,
         "availableDeliveryToAddress":false,
         "isFavorite":false,
         "isContainer":false,
         "sfrequest":null,
         "documents":[
            {
               "id":39513109,
               "uid":null,
               "type":"request",
               "createDate":"2019-11-11 11:16:36",
               "state":"ordered",
               "sender":{
                  "opf":"ОАО",
                  "opfUid":"0x8390b2048d37e0154b845fb22793e865",
                  "name":"APIRequestPositiveSender",
                  "isPhysical":false,
                  "inn":"1234567890",
                  "documentType":null,
                  "documentSeries":null,
                  "documentNumber":null,
                  "counteragentUid":null
               },
               "receiver":{
                  "opf":"ОАО",
                  "opfUid":"0x8390b2048d37e0154b845fb22793e865",
                  "name":"APIRequestPositiveReceiver",
                  "isPhysical":false,
                  "inn":"1234567890",
                  "documentType":null,
                  "documentSeries":null,
                  "documentNumber":null,
                  "counteragentUid":null
               },
               "payer":{
                  "opf":null,
                  "opfUid":"",
                  "name":"APIRequestPositiveSender",
                  "isPhysical":null,
                  "inn":"1234567890",
                  "documentType":null,
                  "documentSeries":null,
                  "documentNumber":null,
                  "counteragentUid":null
               },
               "produceDate":"2019-11-20",
               "forwarderId":null,
               "comment":"Comment",
               "fullDocumentId":"K-39513109",
               "freight":{
                  "name":"Мебельная фурнитура",
                  "weight":0.1,
                  "oversizedWeight":null,
                  "volume":0.1,
                  "oversizedVolume":null,
                  "maxLength":0.1,
                  "maxWidth":0.1,
                  "maxHeight":0.1
               },
               "derival":{
                  "name":"Москва",
                  "code":"7700000000000000000000000"
               },
               "arrival":{
                  "name":"Омск",
                  "code":"5500000100000000000000000"
               },
               "barcode":null,
               "payment":null,
               "totalSum":null,
               "serviceKind":null,
               "organization":null,
               "services":[

               ],
               "accompanyingDocuments":[

               ],
               "availableDocs":[

               ],
               "paymentState":"paid"
            }
         ],
         "paymentState":"paid",
         "note":null,
         "documentsReturnDate":null
      }
   ],
   "deleted":null
}
<response>
   <metadata>
      <status>200</status>
      <currentPage>1</currentPage>
      <nextPage />
      <prevPage />
      <totalPages>1</totalPages>
      <generatedAt>2019-11-11 12:50:20</generatedAt>
   </metadata>
   <orders>
      <orderNumber />
      <orderDate />
      <orderId>39513109</orderId>
      <orderedAt>2019-11-11 08:16:36</orderedAt>
      <state>processing</state>
      <stateName>В обработке</stateName>
      <stateDate />
      <derival>
         <city>г. Москва</city>
         <cityId>3</cityId>
         <cityCode>7700000000000000000000000</cityCode>
         <address>г. Москва, Загорьевский проезд, д. 4</address>
         <addressCode />
         <terminalName>Москва Север 2</terminalName>
         <terminalAddress>127411, Москва г, Лобненская ул, дом № 18, стр 2</terminalAddress>
         <terminalId>36</terminalId>
      </derival>
      <arrival>
         <city>Омск г (Омская обл.)</city>
         <cityId>43</cityId>
         <cityCode>5500000100000000000000000</cityCode>
         <address>Омск г (Омская обл.), 22 Партсъезда ул, д. 4</address>
         <addressCode />
         <terminalName>Омск</terminalName>
         <terminalAddress>644031, Омская обл, Омск г, Омская ул, дом № 221</terminalAddress>
         <terminalId>53</terminalId>
         <terminalCity>Омск</terminalCity>
         <terminalCoordinates>73.4417</terminalCoordinates>
         <terminalCoordinates>54.9939</terminalCoordinates>
         <terminalEmail>pismo@dellin.ru </terminalEmail>
         <terminalPhones>7 (3812) 45-45-45</terminalPhones>
         <callCenterPhones>8-800-100-8000</callCenterPhones>
         <terminalWorktables>
            <sun>24 ч</sun>
            <mon>24 ч</mon>
            <tue>24 ч</tue>
            <wed>24 ч</wed>
            <thu>24 ч</thu>
            <fri>24 ч</fri>
            <sat>24 ч</sat>
         </terminalWorktables>
      </arrival>
      <sender>
         <opf />
         <opfUid />
         <name>APIRequestPositiveSender</name>
         <address>г. Москва, Загорьевский проезд, д. 4</address>
         <isPhysical />
         <inn />
         <documentType />
         <documentSeries />
         <documentNumber />
         <counteragentUid />
         <contacts>contact</contacts>
         <phones>89136665588</phones>
      </sender>
      <receiver>
         <opf />
         <opfUid />
         <name>APIRequestPositiveReceiver</name>
         <address>Омск г (Омская обл.), 22 Партсъезда ул, д. 4</address>
         <isPhysical />
         <inn />
         <documentType />
         <documentSeries />
         <documentNumber />
         <counteragentUid />
         <anonym>false</anonym>
         <anonymPhone />
         <anonymEmail />
      </receiver>
      <payer>
         <opf />
         <opfUid />
         <name>APIRequestPositiveSender</name>
         <isPhysical />
         <inn />
         <documentType />
         <documentSeries />
         <documentNumber />
         <counteragentUid />
      </payer>
      <freight>
         <name>Мебельная фурнитура</name>
         <weight>0.1</weight>
         <oversizedWeight />
         <volume>0.1</volume>
         <oversizedVolume />
         <places>1</places>
         <oversizedPlaces />
         <length>0.1</length>
         <width>0.1</width>
         <height>0.1</height>
      </freight>
      <isAir>false</isAir>
      <air />
      <totalSum>0</totalSum>
      <isPaid>true</isPaid>
      <isPreorder>false</isPreorder>
      <produceDate>2019-11-20</produceDate>
      <declineReason />
      <orderDates>
         <arrivalToOspReceiver>2019-11-27</arrivalToOspReceiver>
         <arrivalToOspReceiverMax />
         <arrivalToOspReceiverAccdoc />
         <arrivalToOspSender />
         <arrivalToReceiver />
         <declineDate />
         <derivalFromOspReceiver>2019-11-27 00:00:00</derivalFromOspReceiver>
         <derivalFromOspReceiverMax />
         <derivalFromOspReceiverAccdoc />
         <giveoutFromOspReceiver />
         <giveoutFromOspReceiverMax />
         <derivalFromOspSender>2019-11-22 00:00:00</derivalFromOspSender>
         <draftLastUpdate />
         <finish />
         <firstDocumentCreatedDate />
         <pickup>2019-11-20 00:00:00</pickup>
         <processingDate>2019-11-11</processingDate>
         <warehousing />
      </orderDates>
      <orderTimeInDays>
         <delivery />
         <deliveryAccdoc />
      </orderTimeInDays>
      <orderedDeliveryFromAddress>true</orderedDeliveryFromAddress>
      <availableDeliveryFromAddress>false</availableDeliveryFromAddress>
      <orderedDeliveryToAddress>true</orderedDeliveryToAddress>
      <availableDeliveryToAddress>false</availableDeliveryToAddress>
      <hasAccess>true</hasAccess>
      <isFavorite>false</isFavorite>
      <isContainer>false</isContainer>
      <sfrequest />
      <documents>
         <id>39513109</id>
         <uid />
         <type>request</type>
         <createDate>2019-11-11 11:16:36</createDate>
         <state>ordered</state>
         <sender>
            <opf>ОАО</opf>
            <opfUid>0x8390b2048d37e0154b845fb22793e865</opfUid>
            <name>APIRequestPositiveSender</name>
            <isPhysical>false</isPhysical>
            <inn>1234567890</inn>
            <documentType />
            <documentSeries />
            <documentNumber />
            <counteragentUid />
         </sender>
         <receiver>
            <opf>ОАО</opf>
            <opfUid>0x8390b2048d37e0154b845fb22793e865</opfUid>
            <name>APIRequestPositiveReceiver</name>
            <isPhysical>false</isPhysical>
            <inn>1234567890</inn>
            <documentType />
            <documentSeries />
            <documentNumber />
            <counteragentUid />
         </receiver>
         <payer>
            <opf />
            <opfUid></opfUid>
            <name>APIRequestPositiveSender</name>
            <isPhysical />
            <inn>1234567890</inn>
            <documentType />
            <documentSeries />
            <documentNumber />
            <counteragentUid />
         </payer>
         <produceDate>2019-11-20</produceDate>
         <forwarderId />
         <comment>Comment</comment>
         <fullDocumentId>K-39513109</fullDocumentId>
         <freight>
            <name>Мебельная фурнитура</name>
            <weight>0.1</weight>
            <oversizedWeight />
            <volume>0.1</volume>
            <oversizedVolume />
            <maxLength>0.1</maxLength>
            <maxWidth>0.1</maxWidth>
            <maxHeight>0.1</maxHeight>
         </freight>
         <derival>
            <name>Москва</name>
            <code>7700000000000000000000000</code>
         </derival>
         <arrival>
            <name>Омск</name>
            <code>5500000100000000000000000</code>
         </arrival>
         <barcode />
         <payment />
         <totalSum />
         <serviceKind />
         <organization />
         <paymentState>paid</paymentState>
      </documents>
      <paymentState>paid</paymentState>
      <note />
      <documentsReturnDate />
   </orders>
   <deleted />
</response>

Описание параметров

Если данные недоступны (например, в запросе не был передан параметр "request.sessionID" или же информация не предоставляется для выбранного вида перевозки, типа документа и т. д.), то в ответе для соответствующего параметра будет передано значение "null".
Response
Response
ПараметрТипДанные доступны неавторизованным пользователям
Описание
metadataobjectДаСистемная информация
metadata.statusintegerДаЭмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.currentPageintegerДаНомер текущей страницы ответа
metadata.nextPageintegerДа

Номер следующей страницы ответа

metadata.prevPageintegerДа

Номер предыдущей страницы ответа.

Если номер текущей страницы ответа - "1", то значение данного параметра - "null"

metadata.totalPagesintegerДаСтраниц всего
metadata.generatedAtstringДа

Дата и время генерации ответа сервера.

Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"

ordersarray of OrdersДаИнформация о заказах
deletedarray of stringsДаСписок удалённых заказов (при передаче в запросе параметра "request.lastUpdate")

Orders

Orders

ПараметрТипДанные доступны неавторизованным пользователямОписание
orderNumberstringДаНомер заказа интернет-магазина (внутренний номер заказа, ВНЗ)
orderDatestringДаДата заказа интернет-магазина
orderIDstringДаНомер заказа
orderedAtstringДаДата создания заказа
statestringДа

Статус заказа на английском языке (см. справочник "Справочник статусов заказа груза")

stateNamestringДаСтатус заказа на русском языке (см. справочник "Справочник статусов заказа груза")
derivalDerivalArrivalЧастично

Информация о месте отправки

arrivalDerivalArrivalЧастично

Информация о месте получения

senderMemberНетИнформация об отправителе
receiverMemberНет

Информация о получателе

payerMemberНет

Информация о плательщике

freightFreightНет

Информация о грузе

isAirbooleanДаПризнак авиаперевозки
airobjectДа

Информация о доставке авиатранспортом

Если значение параметра "isAir" - "false", то вложенные параметры переданы не будут
air.arrivalDatestringДа

Фактическая дата прибытия груза при доставке авиатранспортом

air.giveoutDatestringДа

Дата выдачи груза при доставке авиатранспортом

air.warehousingDatestringДа

Дата начала платного хранения при доставке авиатранспортом

air.deliveryDatestringДа

Ориентировочная дата прибытия груза при доставке авиатранспортом

air.commentstringНетКомментарий
air.orderIdstringДаНомер авианакладной
locksarray of LocksНетМассив блокировок по заказу
totalSumfloatДаОбщая сумма заказа
isPaidbooleanДаСтатус оплаты заказа
isPreorderbooleanНетФлаг, обозначающий что заказ является предзаказом
produceDatestringДа

Дата выполнения заказа

Данные недоступны при заказе услуги "Мультиотправка"
declineReasonstringДа

Причина отклонения

Данные доступны, только если заказ был отклонён
oderDatesobjectДаРасчетный график движения груза
oderDates.arrivalToOspReceiverstringДаДата прибытия груза на терминал-получатель
oderDates.arrivalToOspReceiverMaxstringДа

Максимальная дата прибытия груза на терминал-получатель (в случае, если возможно увеличение срока прибытия)

oderDates.arrivalToOspReceiverMaxAccdocstringДаДата прибытия сопроводительных документов на терминал-получатель
oderDates.arrivalToOspSenderstringДаДата прибытия груза на терминал-отправитель
oderDates.arrivalToReceiverstringДаДата доставки груза до адреса
oderDates.declineDatestringДаДата отклонения
oderDates.derivalFromOspReceiverstringДаДата отправки с терминала-получателя
oderDates.derivalFromOspReceiverMaxstringДаМаксимальная дата отправки с терминала-получателя (в случае, если возможно увеличение срока отправки)
oderDates.derivalFromOspReceiverMaxAccdocstringДаДата отправки сопроводительных документов с терминала-получателя
oderDates.giveoutFromOspReceiverstringДаОриентировочная дата готовности груза к выдаче на терминале-получателе
oderDates.giveoutFromOspReceiverMaxstringДаМаксимальная дата готовности груза к выдаче на терминале-получателе (в случае, если возможно увеличение срока готовности)
oderDates.derivalFromOspSenderstringДаДата отправления груза с терминала-отправителя
oderDates.draftLastUpdatestringДаДата последнего сохранения черновика
oderDates.finishstringДаДата исполнения заказа
oderDates.firstDocumentCreatedDatestringДаДата создания первого документа по заказу
oderDates.pickupstringДаДата передачи груза на адресе отправителя
oderDates.processingDatestringДаДата отправки заявки в обработку
oderDates.warehousingstringДаДата начала платного хранения
orderTimeInDaysobjectДа

Расчетные сроки доставки в днях

Данные доступны, если значение параметра "isAir" = "false". В противном случае значения всех вложенных параметров данного объекта будут содержать "null"
orderTimeInDays.deliveryintegerДаСрок доставки до адреса, дн.
orderTimeInDays.deliveryAccdocintegerДаСрок доставки сопроводительных документов до адреса, дн.
orderedDeliveryFromAddressbooleanДаФлаг, обозначающий что заказана доставка от адреса отправителя
availableDeliveryFromAddressbooleanНетФлаг, обозначающий что возможна доставка от адреса отправителя
orderedDeliveryToAddressbooleanДаФлаг, обозначающий что заказана доставка до адреса получателя
availableDeliveryToAddressbooleanНетФлаг, обозначающий что возможна доставка до адреса получателя
isFavoritebooleanНетПризнак избранного заказа
isContainerbooleanДаФлаг контейнерной перевозки
sfrequestobjectДа

Информация по заявке на доставку до адреса получателя

sfrequest.cityIDintegerДа

ID города доставки из "Справочника терминалов"

sfrequest.docNumberstringДаНомер накладной доставки
sfrequest.pricestringДаСтоимость доставки
documentsDocumentsЧастичноМассив документов заказа
paymentStatestringДа

Статус оплаты.

Возможные значения:

  • "paid" - оплачено;
  • "not_paid" - не оплачено;
  • "in_process" - в процессе
notestringНетКомментарий к заказу
documentsReturnDatestringНетОриентировочная дата возврата сопроводительных документов

DerivalArrival

DerivalArrival

ПараметрТипДанные доступны неавторизованным пользователямОписание
response.oders.derivalresponse.orders.arrival
citystringНетДа

Город отправки/доставки груза

cityIdintegerДаДаID города отправления/прибытия
cityСodestringНетНет

Код КЛАДР города, см. "Справочник населённых пунктов"

addressstringНетНет

Адрес отправки/доставки груза

addressCodestringНетНет

Код КЛАДР улицы, см. "Справочник улиц"

terminalNamestringНетДа

Наименование терминала хранения

terminalAddressstringНетДа

Адрес терминала хранения

terminalIdintegerДаНетID терминала-отправителя/получателя из "Справочника терминалов"
terminalCitystring-Да

Город терминала хранения

Данный параметр используется только для объекта "response.orders.arrival"
terminalCoordinatesarray of float-Да

Долгота и широта терминала хранения

Данный параметр используется только для объекта "response.orders.arrival"
terminalEmailstring-Да

E-mail терминала хранения

Данный параметр используется только для объекта "response.orders.arrival"
terminalPhonesstring-Да

Телефон терминала хранения

Данный параметр используется только для объекта "response.orders.arrival"
callCenterPhonesstring-Да

Телефон кол-центра

Данный параметр используется только для объекта "response.orders.arrival"
terminalWorktablesobject-






Да






График работы терминала хранения (график выдачи груза)

Данный параметр используется только для объекта "response.orders.arrival"
terminalWorktables.sunstring-ДаГрафик работы терминала хранения в воскресенье
terminalWorktables.monstring-ДаГрафик работы терминала хранения в понедельник      
terminalWorktables.tuestring-ДаГрафик работы терминала хранения во вторник    
terminalWorktables.wedstring-ДаГрафик работы терминала хранения в среду
terminalWorktables.thustring-ДаГрафик работы терминала хранения в четверг 
terminalWorktables.fristring-ДаГрафик работы терминала хранения в пятницу 
terminalWorktables.satstring-ДаГрафик работы терминала хранения в субботу

Member
Данные доступны, только если в запросе был передан параметр "sessionID".

Member

ПараметрТипОписание
opfstring

ОПФ 

Для объекта "response.orders.documents.payer": данные недоступны для заявок на перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl")
opfUidstring

UID ОПФ из "Cправочника ОПФ"

Для объекта "response.orders.documents.payer": данные недоступны для заявок на перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl")
namestringНаименование контрагента
addressstring

Адрес контрагента

Параметр используется только для объектов "response.orders.sender", "response.orders.receiver"
isPhysicalboolean

Флаг "Физическое лицо"

Для объекта "response.orders.documents.payer": данные недоступны для заявок на перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl")
innstring

ИНН юр. лица 

Для объекта "response.orders.documents.payer": данные недоступны для заявок на перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl")
documentTypestring

Вид документа физ. лица

Возможные варианты:

  • "Паспорт РФ";
  • "Загранпаспорт";
  • "Водительское удостоверение"
Для объекта "response.orders.documents.payer": данные недоступны для заявок на перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl")
documentSeriesstring

Серия документа физ. лица 

Для объекта "response.orders.documents.payer": данные недоступны для заявок на перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl")
documentNumberstring

Номер документа физ. лица

Для объекта "response.orders.documents.payer": данные недоступны для заявок на перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl")
сounteragentUidstring

UID контрагента

Для объектов "response.orders.documents.sender", "response.orders.documents.receiver", "response.orders.documents.payer": данные доступны только для документа типа "Накладная" (значение параметра "response.orders.documents.type" - "shipping")
contactsstring

ФИО контактного лица отправителя

Параметр используется только для объектов "response.orders.sender" и "response.orders.documents.sender".Для объекта "response.orders.documents.sender": данные доступны только для заявок на доставку от адреса отправителя (значение параметра "response.orders.documents.type" - "request") при оформлении предзаказа
phonesstring

Телефон контрагента

Параметр используется только для объекта "response.orders.sender"
anonymboolean

Признак контрагента с минимальным набором данных - "анонимного получателя"

Параметр используется только для объекта "response.orders.receiver"
anonymEmailstring

E-mail анонимного получателя

Параметр используется только для объекта "response.orders.receiver"
anonymPhonestring

Телефон анонимного получателя

Параметр используется только для объекта "response.orders.receiver"

Freight
Данные доступны, только если в запросе был передан параметр "sessionID"

Freight

ПараметрТипОписание
response.orders.freightresponse.orders.documents.freightresponse.orders.freightresponse.orders.documents.freight
namenamestringstringХарактер груза
weightweight

string

floatВес груза, кг
oversizedWeightoversizedWeight

string

float
Негабаритный вес, кг
volumevolume

string

floatОбъем груза, м3
oversizedVolumeoversizedVolume

string

floatНегабаритный объем, м3
places-integer-

Количество грузовых мест

oversizedPlaces-integer-

Количество негабаритных мест

lengthmaxLengthstringfloat

Длина груза, м

widthmaxWidthstringfloat

Ширина груза, м

heightmaxHeightstringfloat

Высота груза, м

Locks
Данные доступны, только если в запросе был передан параметр "sessionID"

Locks

ПараметрТипОписание
endDatestringДата снятия блокировки
setDatestringДата установки блокировки
namestringНаименование блокировки
typestringТип блокировки

Documents

Documents

ПараметрТипДанные доступны неавторизованным пользователямОписание
idintegerДаНомер документа
uidstringДа

UID накладной

Данные доступны только для документа типа "Накладная" (значение параметра "response.orders.documents.type" - "shipping")
typestringДа

Тип документа.

Возможные значения:

  • "shipping" - накладная;
  • "request" - заявка на доставку от адреса отправителя;
  • "request_sf" - заявка на доставку до адреса получателя;
  • "request_ftl" - заявка на междугороднюю перевозку выделенной еврофурой
createDatestringДа

Дата создания документа

statestringДа

Статус документа

У заявки на доставку от адреса отправителя/до адреса получателя/на междугороднюю перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request"/"request_sf"/"request_ftl") могут быть следующие статусы:

  • "temporary" - заявка не заполнена;
  • "saved" - черновик;
  • "ordered" - заявка в очереди на обработку;
  • "loaded" - заявка взята на обработку;
  • "processed" - заявка обработана;
  • "declined" - заявка отклонена;
  • "accepted" - заявка принята;
  • "canceled" - заявка отменена.

У документа типа "Накладная" (значение параметра "response.orders.documents.type" - "shipping") могут быть следующие статусы:

  • "in_way" - груз в пути;
  • "arrival" - груз прибыл;
  • "give_out" - груз выдан
senderMemberНет

Информация об отправителе

Данные недоступны для заявок на междугороднюю перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl")
receiverMemberНет

Информация о получателе

Данные недоступны для заявок на междугороднюю перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl")
payerMemberНетИнформация о плательщике
produceDatestringДа

Дата исполнения заявки

Данные доступны только для заявок на доставку от адреса отправителя/до адреса получателя (значение параметра "response.orders.documents.type" - "request"/"request_sf")
forwarderIDstringНет

Номер заявки экспедитора

Данные доступны только для заявок на доставку от адреса отправителя/до адреса получателя (значение параметра "response.orders.documents.type" - "request"/"request_sf")
commentstringНет

Комментарии к документам

Данные доступны только для заявок на доставку от адреса отправителя/до адреса получателя (значение параметра "response.orders.documents.type" - "request"/"request_sf")
fullDocumentIdstringДа

Номер полного документа

Данные доступны только для для заявок на доставку от адреса отправителя/до адреса получателя (значение параметра "response.orders.documents.type" - "request"/"request_sf")
freightFreightНет

Информация о грузе

Данные доступны только для заявок на доставку от адреса отправителя и накладных (значение параметра "response.orders.documents.type" - "request"/"shipping")
derivalobjectДа

Информация о месте отправки

Данные доступны только для заявок на доставку от адреса отправителя и накладных (значение параметра "response.orders.documents.type" - "request"/"shipping")
derival.namestringДа

Город

Данные доступны только для заявок на доставку от адреса отправителя и накладных (значение параметра "response.orders.documents.type" - "request"/"shipping")
derival.codestringДа

Код КЛАДР города, см. Справочник населённых пунктов

Данные доступны только для заявок на доставку от адреса отправителя и накладных (значение параметра "response.orders.documents.type" - "request"/"shipping")
arrivalobjectДа

Информация о месте получения

Данные доступны только для заявок на доставку от адреса отправителя и накладных (значение параметра "response.orders.documents.type" - "request"/"shipping")
arrival.namestringДа

Город

Данные доступны только для заявок на доставку от адреса отправителя и накладных (значение параметра "response.orders.documents.type" - "request"/"shipping")
arrival.codestringДа

Код КЛАДР города, см. Справочник населённых пунктов

Данные доступны только для заявок на доставку от адреса отправителя и накладных (значение параметра "response.orders.documents.type" - "request"/"shipping")
barcodestringНет

Barcode для формирования штрихкода по алгоритму Code 128 (для заявки на предзаказ)

paymentbooleanДа

Статус оплаты

Данные доступны только для накладных (значение параметра "response.orders.documents.type" - "shipping")
totalSumintegerДа

Общая сумма по накладной

Данные доступны только для накладных (значение параметра "response.orders.documents.type" - "shipping")
serviceKindstringДа

Тип перевозки

Данные доступны только для накладных (значение параметра "response.orders.documents.type" - "shipping")
organizationstringНет

ID организации

Данные доступны только для накладных (значение параметра "response.orders.documents.type" - "shipping")
servicesarray of ServicesЧастично

Перечень услуг по накладной

Данные доступны только для накладных (значение параметра "response.orders.documents.type" - "shipping")
accompanyingDocumentsarray of AcDocНет

Перечень сопроводительных документов

Данные доступны только для накладных (значение параметра "response.orders.documents.type" - "shipping")
availableDocsarray of stringНет

Перечень документов, по которым можно получить печатные формы

Параметр используется только для накладных (значение параметра "response.orders.documents.type" - "shipping")
paymentStatestringДа

Статус оплаты сопроводительных документов на английском языке

Возможные значения:

  • "paid" - оплачено;
  • "not_paid" - не оплачено;
  • "in_process" - в процессе

Параметр используется только для накладных (значение параметра "response.orders.documents.type" - "shipping")

Services
Неавторизованному пользователю доступен только параметр "response.orders.documents.services.name". Прочие данные доступны, только если в запросе был передан параметр "sessionID"
Services
ПараметрТипОписание
namestringНаименование услуги
serviceUidstringUID услуги
createdAtstringДата создания
quantityintegerКоличество
sumstringСумма
totalSumstringСумма итого
discountSumstringСумма скидки

AcDoc
AcDoc
ПараметрТипОписание
documentDatestringДата создания сопроводительного документа
documentNumberstringНомер сопроводительного документа
documentKindstringКомментарий (тип документа)

Обработка ошибок

Помимо общих ошибок API, в ответе метода могут присутствовать следующие ошибки:

Номер ошибки

http-код

Краткое описание ошибки

Детальное описание ошибки

718001

400

Найдено более одного заказа

Воспользуйтесь расширенным поиском

717001

400

Заказ не найден

Заказ [номер заказа] не найден

717002

400

Неизвестный статус заказа

Детальное описание ошибки содержит номера заказов с неизвестным статусом