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

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

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

Обновлено 04.09.2020
286 кб

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

Сервис позволяет получать актуальную информацию о заказах, используя номер заказа компании "Деловые Линии", номер накладной или заявки, внутренний номер заказа интернет-магазина или штрих-код документа. Авторизованные пользователи при помощи данного метода также могут получить журнал отправок личного кабинета, в том числе актуальные статусы заказов, заявок и накладных.

Для идентификации состава ответа используется входящий параметр "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",
   "orderBy":"ordered_at",
   "orderDatesAdditional":true
}

Адрес метода: 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>
   <orderBy>ordered_at</orderBy>
   <orderDatesAdditional>true</orderDatesAdditional>
</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

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

Для поиска заказа могут быть использованы следующие штрих-коды:

  • штрих-код накладной (первые три символа кода - 128);
  • штрих-код накладной экспедитора (документ используется водителем-экспедитором при получении груза на адресе отправителя, первые три символа - 098);
  • штрих-код заявки на доставку груза, оформленной при размещении предзаказа (первые три символа кода - 415);
  • штрих-код, считанный с этикетки на грузе (код документа "Накладная" с указанием грузоместа, первые три символа кода - 728).

При передаче штрих-кода, считанного с этикетки на грузе, длина поля составляет 29 символов, в остальных случаях - 25 символов.

*Параметр используется для поиска заказа. Если в запросе отсутствует параметр "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".

Если в запросе передан параметр "states" со значением "inway", то в ответ будут включены все заказы в статусе "inway", не зависимо от значения параметра "lastUpdate" (для прочих статусов действует иная логика - в ответ включаются заказы в указанных статусах, обновлённые после даты, переданной в параметре "lastUpdate")

orderByНетstring

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

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

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

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

orderDatesAdditional

НетbooleanФлаг, обозначающий, что необходима информация о промежуточных точках маршрута перевозки

Ответ метода

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

{
   "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,
         "progressPercent": 1,
         "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 ч"
            }
         },
         "detailedStatus": null,
         "detailedStatusRus": null,
         "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"
            }
         ],
         "orderDatesAdditional": {
            "tracing": [
               {
                  "title": "Отбытие из ОСП",
                  "date": "2019-11-23",
                  "cityUID": "0x834f00112fdd658311da4c6326ef0e0e",
                  "cityName": "Волгоград",
                  "status": "inway"
               },
               {
                  "title": "Отбытие из ОСП",
                  "date": "2019-11-24",
                  "cityUID": "0x834f00112fdd658311da4c6326ef0e19",
                  "cityName": "Уфа",
                  "status": "inway"
               }
            ]
         },
         "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 />
      <progressPercent>1</progressPercent>
      <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>
      <detailedStatus />
      <detailedStatusRus />
      <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>
      <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>
      <orderDatesAdditional>
         <tracing>
            <title>Отбытие из ОСП</title>
            <date>2019-11-23</date>
            <cityUID>0x834f00112fdd658311da4c6326ef0e0e</cityUID>
            <cityName>Волгоград</cityName>
            <status>inway</status>
         </tracing>
         <tracing>
            <title>Отбытие из ОСП</title>
            <date>2019-11-24</date>
            <cityUID>0x834f00112fdd658311da4c6326ef0e19</cityUID>
            <cityName>Уфа</cityName>
            <status>inway</status>
         </tracing>
      </orderDatesAdditional>
      <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ДаДата создания заказа

state

stringДа

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

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

Дата установки текущего статуса.

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

Если статус заказа - черновик (значение параметра ответа "orders.state" - "draft"), то значение параметра - null

progressPercentintegerДаСтепень выполнения заказа (в процентах). Значение параметра может быть использовано для визуализации хода выполнения заказа 
derivalDerivalArrivalЧастично

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

arrivalDerivalArrivalЧастично

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

detailedStatusstringДа

Дополнительный статус заказа на английском языке.

Возможные значения (порядок соответствует порядку возможных значений параметра "detailedStatusRus"):

  • "pickup_waiting_pickup";
  • "pickup_departed";
  • "pickup_arrived";
  • "pickup_arrived_at_first";
  • "pickup_arrived_at_last";
  • "pickup_finished";
  • "delivery_waiting_delivery";
  • "delivery_departed";
  • "delivery_arrived";
  • "delivery_finished"
detailedStatusRusstringДа

Дополнительный статус заказа на русском языке.

Возможные значения (порядок соответствует порядку возможных значений параметра "detailedStatus"):

  • "Ожидается забор" - водитель ещё не выехал на адрес отправителя;
  • "Машина едет на адрес";
  • "Машина на адресе";
  • "Прибыл на первый адрес";
  • "Прибыл на последний адрес";
  • "Груз забран. Едет на терминал";
  • "Ожидается доставка" - водитель ещё не выехал на адрес получателя;
  • "Машина едет на адрес";
  • "Машина на адресе";
  • "Груз доставлен"
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Да

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

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

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

orderDates.arrivalToOspReceiverMaxAccdocstringДаДата прибытия сопроводительных документов на терминал-получатель
orderDates.arrivalToOspSenderstringДаДата прибытия груза на терминал-отправитель
orderDates.arrivalToReceiverstringДаДата доставки груза до адреса
orderDates.declineDatestringДа

Дата отклонения

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

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

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

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

sfrequest.cityIDintegerДа

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

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

Информация о промежуточных точках маршрута перевозки

Параметр отсутствует в ответе, если заказ отклонён или с момента завершения заказа прошло более 24 часов (значение параметра "" - "declined" или же значение параметра "" изменилось на "finished" более 24 часов назад)
paymentStatestringДа

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

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

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

Ориентировочная дата возврата сопроводительных документов.

DerivalArrival

DerivalArrival

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

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

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

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

addressstringНетНет

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

addressCodestringНетНет

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

terminalNamestringНетДа

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

terminalAddressstringНетДа

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

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

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

terminalCoordinatesarray of float-Да

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

terminalEmailstring-Да

Email терминала хранения (1)

terminalPhonesstring-Да

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

callCenterPhonesstring-Да

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

terminalWorktablesobject-Да

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

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

Примечания:

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

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

Member

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

ОПФ (1)

opfUidstring

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

namestringНаименование контрагента
addressstring

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

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

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

innstring

ИНН юр. лица  (1)

documentTypestring

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

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

  • "Паспорт РФ";
  • "Загранпаспорт";
  • "Водительское удостоверение"
documentSeriesstring

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

documentNumberstring

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

с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

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

anonymEmailstring

Email "анонимного" получателя (2)

anonymPhonestring

Телефон "анонимного" получателя (2)

Примечания:

  1. Для объекта "response.orders.documents.payer": данные недоступны для заявок на перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl").
  2. "Анонимный" получатель - получатель, о котором предоставлен минимум информации (см. описание услуги "Упрощённая отправка груза" на сайте компании "Деловые Линии"). Параметр используется только для объекта "response.orders.receiver"

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

Freight

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

string

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

string

float
Вес негабаритных грузовых мест, кг (1)
volumevolume

string

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

string

floatОбъем негабаритных грузовых мест, м3 (1)
places-integer-

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

oversizedPlaces-integer-

Количество негабаритных грузовых мест (1)

lengthmaxLengthstringfloat

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

widthmaxWidthstringfloat

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

heightmaxHeightstringfloat

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

Примечания:

  1. Негабаритное грузовое место - это грузовое место, вес которого больше либо равен 100 кг (80 кг в случае перевозки авиатранспортом) или одно из измерений (Д*Ш*В) которого больше либо равно 3 м (80 см в случае перевозки авиатранспортом)

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

Locks

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

Documents

Documents

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

UID накладной (1)

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Нет

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

receiverMemberНет

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

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

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

forwarderIDstringНет

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

commentstringНет

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

fullDocumentIdstringДа

Полный номер документа (3)

freightFreightНет

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

derivalobjectДа

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

derival.namestringДа

Город (4)

derival.codestringДа

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

arrivalobjectДа

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

arrival.namestringДа

Город (4)

arrival.codestringДа

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

barcodestringНет

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

paymentbooleanДа

Статус оплаты (1)

totalSumintegerДа

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

serviceKindstringДа

Тип перевозки (1)

organizationstringНет

ID организации (1)

servicesarray of ServicesЧастично

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

accompanyingDocumentsarray of AcDocНет

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

availableDocsarray of stringНет

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

paymentStatestringДа

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

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

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

Примечания:

  1. Данные доступны только для документа типа "Накладная" (значение параметра "response.orders.documents.type" - "shipping").
  2. Данные недоступны для заявок на междугороднюю перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl").
  3. Данные доступны только для заявок на доставку груза (в случае, если заказан доставка от адреса отправителя/до адреса получателя)/заявок на доставку груза от терминала до адреса получателя (значение параметра "response.orders.documents.type" - "request"/"request_sf").
  4. Данные доступны только для заявок на доставку груза (от адреса отправителя или от терминала) и накладных (значение параметра "response.orders.documents.type" - "request"/"shipping")

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

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

OrderDatesAdditional

OrderDatesAdditional

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

tracing

array of TracingСписок промежуточных точек маршрута перевозки. Максимальное число элементов массива - 10. Если промежуточных точек больше 10, то в ответе метода будет представлена информация по 10 последним точкам маршрута

tracing.title

stringСобытие, дата которого передаётся в параметре "tracing.date". Значение всегда "Отбытие из ОСП"

tracing.date

string

Дата прохождения точки маршрута.

Формат даты: ГГГГ-ММ-ДД

tracing.cityUID

stringUID города (промежуточной точки маршрута)

tracing.cityName

stringГород (промежуточная точка маршрута)

tracing.status

string

Статус заказа на момент прохождения точки маршрута. Значение всегда "inway" (см. "Справочник статусов заказа груза")

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

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

Номер ошибки

http-код

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

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

718001

400

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

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

717001

400

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

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

717002

400

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

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