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

Обновлено 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	Флаг, обозначающий, что необходима информация о промежуточных точках маршрута перевозки

Ответ метода

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

JSON
XML

{
   "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
Параметр	Тип	Данные доступны неавторизованным пользователям	Описание
metadata	object	Да	Системная информация
metadata.status	integer	Да	Эмуляция http-кода состояния. В случае успешного выполнения возвращается код "200" (OK)
metadata.currentPage	integer	Да	Номер текущей страницы ответа
metadata.nextPage	integer	Да	Номер следующей страницы ответа
metadata.prevPage	integer	Да	Номер предыдущей страницы ответа. Если номер текущей страницы ответа - "1", то значение данного параметра - "null"
metadata.totalPages	integer	Да	Страниц всего
metadata.generatedAt	string	Да	Дата и время генерации ответа сервера. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС"
orders	array of Orders	Да	Информация о заказах
deleted	array of strings	Да	Список удалённых заказов (при передаче в запросе параметра "request.lastUpdate")

Orders

Orders
Параметр	Тип	Данные доступны неавторизованным пользователям	Описание
orderNumber	string	Да	Номер заказа интернет-магазина (внутренний номер заказа, ВНЗ)
orderDate	string	Да	Дата заказа интернет-магазина
orderID	string	Да	Номер заказа
orderedAt	string	Да	Дата создания заказа
state	string	Да	Статус заказа на английском языке (см. справочник "Справочник статусов заказа груза")
stateName	string	Да	Статус заказа на русском языке (см. справочник "Справочник статусов заказа груза")
stateDate	string	Да	Дата установки текущего статуса. Формат: "ГГГГ-ММ-ДД". Если статус заказа - черновик (значение параметра ответа "orders.state" - "draft"), то значение параметра - null
progressPercent	integer	Да	Степень выполнения заказа (в процентах). Значение параметра может быть использовано для визуализации хода выполнения заказа
derival	DerivalArrival	Частично	Информация о месте отправки
arrival	DerivalArrival	Частично	Информация о месте получения
detailedStatus	string	Да	Дополнительный статус заказа на английском языке. Возможные значения (порядок соответствует порядку возможных значений параметра "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"
detailedStatusRus	string	Да	Дополнительный статус заказа на русском языке. Возможные значения (порядок соответствует порядку возможных значений параметра "detailedStatus"): "Ожидается забор" - водитель ещё не выехал на адрес отправителя; "Машина едет на адрес"; "Машина на адресе"; "Прибыл на первый адрес"; "Прибыл на последний адрес"; "Груз забран. Едет на терминал"; "Ожидается доставка" - водитель ещё не выехал на адрес получателя; "Машина едет на адрес"; "Машина на адресе"; "Груз доставлен"
sender	Member	Нет	Информация об отправителе
receiver	Member	Нет	Информация о получателе
payer	Member	Нет	Информация о плательщике
freight	Freight	Нет	Информация о грузе
isAir	boolean	Да	Признак авиаперевозки
air	object	Да	Информация о доставке авиатранспортом Если значение параметра "isAir" - "false", то вложенные параметры переданы не будут
air.arrivalDate	string	Да	Фактическая дата прибытия груза при доставке авиатранспортом
air.giveoutDate	string	Да	Дата выдачи груза при доставке авиатранспортом
air.warehousingDate	string	Да	Дата начала платного хранения при доставке авиатранспортом
air.deliveryDate	string	Да	Ориентировочная дата прибытия груза при доставке авиатранспортом
air.comment	string	Нет	Комментарий
air.orderId	string	Да	Номер авианакладной
locks	array of Locks	Нет	Массив блокировок по заказу
totalSum	float	Да	Общая сумма заказа
isPaid	boolean	Да	Статус оплаты заказа
isPreorder	boolean	Нет	Флаг, обозначающий что заказ является предзаказом
produceDate	string	Да	Дата выполнения заказа Данные недоступны при заказе услуги "Мультиотправка"
declineReason	string	Да	Причина отклонения Данные доступны, только если заказ был отклонён
orderDates	object	Да	Расчетный график движения груза
orderDates.arrivalToOspReceiver	string	Да	Дата прибытия груза на терминал-получатель
orderDates.arrivalToOspReceiverMax	string	Да	Максимальная дата прибытия груза на терминал-получатель (в случае, если возможно увеличение срока прибытия)
orderDates.arrivalToOspReceiverMaxAccdoc	string	Да	Дата прибытия сопроводительных документов на терминал-получатель
orderDates.arrivalToOspSender	string	Да	Дата прибытия груза на терминал-отправитель
orderDates.arrivalToReceiver	string	Да	Дата доставки груза до адреса
orderDates.declineDate	string	Да	Дата отклонения В отдельных случаях данные могут отсутствовать
orderDates.derivalFromOspReceiver	string	Да	Дата отправки с терминала-получателя
orderDates.derivalFromOspReceiverMax	string	Да	Максимальная дата отправки с терминала-получателя (в случае, если возможно увеличение срока отправки)
orderDates.derivalFromOspReceiverMaxAccdoc	string	Да	Дата отправки сопроводительных документов с терминала-получателя
orderDates.giveoutFromOspReceiver	string	Да	Ориентировочная дата готовности груза к выдаче на терминале-получателе
orderDates.giveoutFromOspReceiverMax	string	Да	Максимальная дата готовности груза к выдаче на терминале-получателе (в случае, если возможно увеличение срока готовности)
orderDates.derivalFromOspSender	string	Да	Дата отправления груза с терминала-отправителя
orderDates.draftLastUpdate	string	Да	Дата последнего сохранения черновика
orderDates.finish	string	Да	Дата исполнения заказа
orderDates.firstDocumentCreatedDate	string	Да	Дата создания первого документа по заказу
orderDates.pickup	string	Да	Дата передачи груза на адресе отправителя
orderDates.processingDate	string	Да	Дата отправки заявки в обработку
orderDates.warehousing	string	Да	Дата начала платного хранения
orderTimeInDays	object	Да	Расчетные сроки доставки в днях Данные доступны, если значение параметра "isAir" = "false". В противном случае значения всех вложенных параметров данного объекта будут содержать "null"
orderTimeInDays.delivery	integer	Да	Срок доставки до адреса, дн.
orderTimeInDays.deliveryAccdoc	integer	Да	Срок доставки сопроводительных документов до адреса, дн.
orderedDeliveryFromAddress	boolean	Да	Флаг, обозначающий что заказана доставка от адреса отправителя
availableDeliveryFromAddress	boolean	Нет	Флаг, обозначающий что возможна доставка от адреса отправителя
orderedDeliveryToAddress	boolean	Да	Флаг, обозначающий что заказана доставка до адреса получателя
availableDeliveryToAddress	boolean	Нет	Флаг, обозначающий что возможна доставка до адреса получателя
isFavorite	boolean	Нет	Признак избранного заказа
isContainer	boolean	Да	Флаг контейнерной перевозки
sfrequest	object	Да	Информация по заявке на доставку до адреса получателя
sfrequest.cityID	integer	Да	ID города доставки из "Справочника терминалов"
sfrequest.docNumber	string	Да	Номер накладной доставки
sfrequest.price	string	Да	Стоимость доставки
documents	Documents	Частично	Массив документов заказа
orderDatesAdditional	OrderDatesAdditional	Да	Информация о промежуточных точках маршрута перевозки Параметр отсутствует в ответе, если заказ отклонён или с момента завершения заказа прошло более 24 часов (значение параметра "" - "declined" или же значение параметра "" изменилось на "finished" более 24 часов назад)
paymentState	string	Да	Статус оплаты. Возможные значения: "paid" - оплачено; "not_paid" - не оплачено; "in_process" - в процессе
note	string	Нет	Комментарий к заказу
documentsReturnDate	string	Нет	Ориентировочная дата возврата сопроводительных документов.

DerivalArrival

DerivalArrival
Параметр	Тип	Данные доступны неавторизованным пользователям		Описание
Параметр	Тип	response.orders.derival	response.orders.arrival	Описание
city	string	Нет	Да	Город отправки/доставки груза
cityId	integer	Да	Да	ID города отправления/прибытия
cityСode	string	Нет	Нет	Код КЛАДР города, см. "Справочник населённых пунктов"
address	string	Нет	Нет	Адрес отправки/доставки груза
addressCode	string	Нет	Нет	Код КЛАДР улицы, см. "Справочник улиц"
terminalName	string	Нет	Да	Наименование терминала хранения
terminalAddress	string	Нет	Да	Адрес терминала хранения
terminalId	integer	Да	Нет	ID терминала-отправителя/получателя из "Справочника терминалов"
terminalCity	string	-	Да	Город терминала хранения (1)
terminalCoordinates	array of float	-	Да	Долгота и широта терминала хранения (1)
terminalEmail	string	-	Да	Email терминала хранения (1)
terminalPhones	string	-	Да	Телефон терминала хранения (1)
callCenterPhones	string	-	Да	Телефон кол-центра (1)
terminalWorktables	object	-	Да	График работы терминала хранения (график выдачи груза) (1)
terminalWorktables.sun	string	-	Да	График работы терминала хранения в воскресенье
terminalWorktables.mon	string	-	Да	График работы терминала хранения в понедельник
terminalWorktables.tue	string	-	Да	График работы терминала хранения во вторник
terminalWorktables.wed	string	-	Да	График работы терминала хранения в среду
terminalWorktables.thu	string	-	Да	График работы терминала хранения в четверг
terminalWorktables.fri	string	-	Да	График работы терминала хранения в пятницу
terminalWorktables.sat	string	-	Да	График работы терминала хранения в субботу
Примечания: Данный параметр используется только для объекта "response.orders.arrival"

Member

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

Member
Параметр	Тип	Описание
opf	string	ОПФ (1)
opfUid	string	UID ОПФ из "Cправочника ОПФ" (1)
name	string	Наименование контрагента
address	string	Адрес контрагента Параметр используется только для объектов "response.orders.sender", "response.orders.receiver"
isPhysical	boolean	Флаг "Физическое лицо" (1)
inn	string	ИНН юр. лица (1)
documentType	string	Вид документа физ. лица (1) Возможные значения: "Паспорт РФ"; "Загранпаспорт"; "Водительское удостоверение"
documentSeries	string	Серия документа физ. лица (1)
documentNumber	string	Номер документа физ. лица (1)
сounteragentUid	string	UID контрагента Для объектов "response.orders.documents.sender", "response.orders.documents.receiver", "response.orders.documents.payer": данные доступны только для документа типа "Накладная" (значение параметра "response.orders.documents.type" - "shipping")
contacts	string	ФИО контактного лица отправителя Параметр используется только для объектов "response.orders.sender" и "response.orders.documents.sender".Для объекта "response.orders.documents.sender": данные доступны только для заявок на доставку груза (значение параметра "response.orders.documents.type" - "request") при оформлении предзаказа
phones	string	Телефон контрагента Параметр используется только для объекта "response.orders.sender"
anonym	boolean	Признак контрагента с минимальным набором данных - "анонимного" получателя (2)
anonymEmail	string	Email "анонимного" получателя (2)
anonymPhone	string	Телефон "анонимного" получателя (2)
Примечания: Для объекта "response.orders.documents.payer": данные недоступны для заявок на перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl"). "Анонимный" получатель - получатель, о котором предоставлен минимум информации (см. описание услуги "Упрощённая отправка груза" на сайте компании "Деловые Линии"). Параметр используется только для объекта "response.orders.receiver"

Freight

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

Freight
Параметр		Тип		Описание
response.orders.freight	response.orders.documents.freight	response.orders.freight	response.orders.documents.freight	Описание
name	name	string	string	Характер груза
weight	weight	string	float	Вес груза, кг
oversizedWeight	oversizedWeight	string	float	Вес негабаритных грузовых мест, кг (1)
volume	volume	string	float	Объем груза, м3
oversizedVolume	oversizedVolume	string	float	Объем негабаритных грузовых мест, м3 (1)
places	-	integer	-	Количество грузовых мест
oversizedPlaces	-	integer	-	Количество негабаритных грузовых мест (1)
length	maxLength	string	float	Длина груза, м
width	maxWidth	string	float	Ширина груза, м
height	maxHeight	string	float	Высота груза, м
Примечания: Негабаритное грузовое место - это грузовое место, вес которого больше либо равен 100 кг (80 кг в случае перевозки авиатранспортом) или одно из измерений (ДШВ) которого больше либо равно 3 м (80 см в случае перевозки авиатранспортом)

Locks

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

Locks
Параметр	Тип	Описание
endDate	string	Дата снятия блокировки
setDate	string	Дата установки блокировки
name	string	Наименование блокировки
type	string	Тип блокировки

Documents

Documents
Параметр	Тип	Данные доступны неавторизованным пользователям	Описание
id	integer	Да	Номер документа
uid	string	Да	UID накладной (1)
type	string	Да	Тип документа. Возможные значения: "shipping" - накладная; "request" - заявка на доставку груза (от адреса отправителя или от терминала); "request_sf" - заявка на доставку до адреса получателя (от терминала); "request_ftl" - заявка на междугороднюю перевозку выделенной еврофурой
createDate	string	Да	Дата создания документа
state	string	Да	Статус документа У заявки на доставку от адреса отправителя/до адреса получателя/на междугороднюю перевозку выделенной еврофурой (значение параметра "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" - груз выдан
sender	Member	Нет	Информация об отправителе (2)
receiver	Member	Нет	Информация о получателе (2)
payer	Member	Нет	Информация о плательщике
produceDate	string	Да	Дата исполнения заявки (3)
forwarderID	string	Нет	Номер заявки экспедитора (3)
comment	string	Нет	Комментарии к документам (3)
fullDocumentId	string	Да	Полный номер документа (3)
freight	Freight	Нет	Информация о грузе (4)
derival	object	Да	Информация о месте отправки (4)
derival.name	string	Да	Город (4)
derival.code	string	Да	Код КЛАДР города, см. Справочник населённых пунктов (4)
arrival	object	Да	Информация о месте получения (4)
arrival.name	string	Да	Город (4)
arrival.code	string	Да	Код КЛАДР города, см. Справочник населённых пунктов (4)
barcode	string	Нет	Barcode для формирования штрих-кода по алгоритму Code 128 (для заявки на предзаказ)
payment	boolean	Да	Статус оплаты (1)
totalSum	integer	Да	Общая сумма по накладной (1)
serviceKind	string	Да	Тип перевозки (1)
organization	string	Нет	ID организации (1)
services	array of Services	Частично	Перечень услуг по накладной (1)
accompanyingDocuments	array of AcDoc	Нет	Перечень сопроводительных документов (1)
availableDocs	array of string	Нет	Перечень документов, по которым можно получить печатные формы (1)
paymentState	string	Да	Статус оплаты сопроводительных документов на английском языке (1) Возможные значения: "paid" - оплачено; "not_paid" - не оплачено; "in_process" - в процессе
Примечания: Данные доступны только для документа типа "Накладная" (значение параметра "response.orders.documents.type" - "shipping"). Данные недоступны для заявок на междугороднюю перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request_ftl"). Данные доступны только для заявок на доставку груза (в случае, если заказан доставка от адреса отправителя/до адреса получателя)/заявок на доставку груза от терминала до адреса получателя (значение параметра "response.orders.documents.type" - "request"/"request_sf"). Данные доступны только для заявок на доставку груза (от адреса отправителя или от терминала) и накладных (значение параметра "response.orders.documents.type" - "request"/"shipping")

Services

Неавторизованному пользователю доступен только параметр "response.orders.documents.services.name". Прочие данные доступны, только если в запросе был передан параметр "sessionID"

Services
Параметр	Тип	Описание
name	string	Наименование услуги
serviceUid	string	UID услуги
createdAt	string	Дата создания
quantity	integer	Количество
sum	string	Сумма
totalSum	string	Сумма итого
discountSum	string	Сумма скидки

AcDoc

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

OrderDatesAdditional

OrderDatesAdditional
Параметр	Тип	Описание
tracing	array of Tracing	Список промежуточных точек маршрута перевозки. Максимальное число элементов массива - 10. Если промежуточных точек больше 10, то в ответе метода будет представлена информация по 10 последним точкам маршрута
tracing.title	string	Событие, дата которого передаётся в параметре "tracing.date". Значение всегда "Отбытие из ОСП"
tracing.date	string	Дата прохождения точки маршрута. Формат даты: ГГГГ-ММ-ДД
tracing.cityUID	string	UID города (промежуточной точки маршрута)
tracing.cityName	string	Город (промежуточная точка маршрута)
tracing.status	string	Статус заказа на момент прохождения точки маршрута. Значение всегда "inway" (см. "Справочник статусов заказа груза")

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

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

Номер ошибки	http-код	Краткое описание ошибки	Детальное описание ошибки
718001	400	Найдено более одного заказа	Воспользуйтесь расширенным поиском
717001	400	Заказ не найден	Заказ [номер заказа] не найден
717002	400	Неизвестный статус заказа	Детальное описание ошибки содержит номера заказов с неизвестным статусом

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

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

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

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

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

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

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

Request

Ответ метода

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

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

Response

Orders

DerivalArrival

Member

Freight

Locks

Documents

Services

AcDoc

OrderDatesAdditional

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