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

API
Главная / API - Журнал заказов

Журнал заказов

Обновлено 03.10.2017
203 кб

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

Сервис позволяет получать журнал отправок Личного кабинета, в том числе актуальные статусы Ваших заказов, заявок и накладных.

Данные о заказах предоставляются одновременно по всем контрагентам, к которым у Вашего аккаунта в Личном кабинете есть доступ (подробнее о доступе). Также предоставляются данные о заказах, оформленных Вами через сайт, и об избранных заказах. Если у Вас нет доступа ни к одному контрагенту, Вы сможете получать только информацию о заказах, оформленных через сайт, и об избранных заказах.

Журнал заказов

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

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

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

{   
   "appkey":"00000000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "docid":"53654635",
   "date_start":"2015-05-01 10:23:58",
   "date_end":"2015-05-05 23:15:18",
   "lastupdate":"2015-06-10 16:31:23",
   "states":[  
      "inway",
      "arrived"
   ],
   "page":3,
   "response_format":"default"
}

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

<request>
   <appkey>00000000-0000-0000-000000000000</appkey>
   <sessionid>00000000-0000-0000-0000-000000000000</sessionid>
   <docid>53654635</docid>
   <date_start>2015-05-01 10:23:58</date_start>
   <date_end>2015-05-05 23:15:18</date_end>
   <lastupdate>2015-06-10 16:31:23</lastupdate>
   <states>inway</states>
   <states>arrived</states>
   <page>3</page>
   <response_format>default</response_format>
</request>

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

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

sessionID

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

docid

НетstringНомер документа. Если параметр указан, то поиск осуществляется только по номеру заказа, накладной или заявки (остальные фильтры не учитываются)
date_startНетstring

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

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

date_endНетstring

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

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

lastupdateНетstring

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

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

statesНетarray of stringСписок статусов, заказы с которыми надо получить в ответе. Статусы указываются на основании "Справочника статусов заказа груза"
pageНетinteger

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

response_formatНетstring

Формат ответа API.

Доступные варианты:

  • "default" - текстовый формат
  • "idly" - представление данных в виде кодов, где это возможно
  • "full" - все возможные поля

Значение по умолчанию: "default"

Ответ метода

Набор параметров объекта "Respone.Orders.Receiver" зависит от того, является получатель контрагентом со стандартным или с минимальным набором параметров (анонимный получатель). Рассмотрим пример ответа, когда получатель груза не является анонимным получателем:

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

{  
   "orders":[  
      {  
         "id":"53654635",
         "ordered_at":"2015-05-13 11:20:05",
         "state":"received",
         "state_date":"2015-05-13",
         "derival":{  
            "city":"Москва",
            "address":"129345, Москва г, Магаданская ул, дом № 1",
            "city_code":"7700000000000000000000000",
            "address_code":"7700000000017620000000000",
            "terminal_name":"Москва-Запад",
            "terminal_address":"119361, Москва г, Очаковская М. ул, дом № 4",
            "terminal_id":18
         },
         "arrival":{  
            "city":"Омск",
            "address":"644027, Омская обл, Омск г, 20 лет РККА ул, дом № 302, литера А",
            "city_code":"5500000100000000000000000",
            "address_code":"5500000100006380000000000",
            "terminal_name":"Омск",
            "terminal_address":"644027, Омская обл, Омск г, 20 лет РККА ул, дом № 302, литера А",
            "terminal_id":53
         },
         "sender":{  
            "opf":"ООО",
            "opf_uid":"0x92ee033543fsdff9910cd87ca9ca",
            "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
            "address":"109382, Москва г, Армавирская ул, дом № 1",
            "is_physical":false,
            "inn":"7842463725",
            "document_type":null,
            "document_series":null,
            "document_number":null,
            "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
         },
         "receiver":{  
            "opf":"ООО",
            "opf_uid":"0x92ee03691543sdfs9910cd87ca9ca",
            "name":"ИП \"Пушкин Юрий Геннадьевич\"",
            "address":"Омская обл, Омск г, 10 лет Октября ул, дом № 180",
            "is_physical":true,
            "inn":"",
            "document_type":"Паспорт РФ",
            "document_series":null,
            "document_number":null,
            "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
         },
         "payer":{  
            "opf":"ООО",
            "opf_uid":"0x92ee0534sdfdfdsfcd87ca9ca",
            "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
            "is_physical":false,
            "inn":"7842463725",
            "document_type":null,
            "document_series":null,
            "document_number":null,
            "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
         },
         "freight":{  
            "name":"МЕБЕЛЬ",
            "weight":"1.0",
            "oversized_weight":"0.0",
            "volume":"1.0",
            "oversized_volume":"0.0",
            "places":1,
            "oversized_places":0,
            "length":"0.0",
            "width":"0.0",
            "height":"0.0"
         },
         "air":{  
            "order_id":null,
            "comment":null,
            "delivery_date":null
         },
         "locks":[  
            {  
               "name":"Долг",
               "type":"by_payment",
               "set_date":"2015-05-12 16:38:38",
               "end_date":null
            }
         ],
         "documents":[],
         "total_sum":"3480.0",
         "is_paid":false,
         "is_preorder":true,
         "ordered_delivery_from_address":true,
         "available_delivery_from_address":false,
         "ordered_delivery_to_address":true,
         "available_delivery_to_address":false,
         "is_favorite":false,
         "is_air":false,
         "estimated_delivery_date":null,
         "arrival_date":null,
         "giveout_date":null,
         "warehousing_date":null,
         "produce_date":"2015-05-14",
         "order_dates":{  
            "arrival_to_receiver":"2016-04-01",
            "arrival_to_osp_sender":"2016-04-01",
            "arrival_to_osp_receiver_accdoc":"2016-04-01",
            "first_document_created_date":"2016-04-01",
            "draft_last_update":"2016-04-01",
            "arrival_to_osp_receiver":"2016-04-01",
            "processing_date":"2016-06-27",
            "derival_from_osp_receiver_accdoc":"2016-04-01",
            "derival_from_osp_receiver":"2016-04-01",
            "warehousing":"2016-04-01",
            "decline_date":"2016-04-01",
            "pickup":"2016-04-01",
            "finish":"2016-04-01"
         },
         "order_time_in_days":{  
            "delivery":2,
            "delivery_accdoc":2
         }
      }
   ],
   "deleted":[  
      "3956984",
      "3956289",
      "3955733"
   ],
   "metadata":{  
      "next_page":2,
      "current_page":1,
      "total_pages":74,
      "prev_page":null,
      "generated_at":"2015-06-18 12:37:28"
   }
}
<response>
   <orders>
      <id>53654635</id>
      <ordered_at>2015-05-13 11:20:05</ordered_at>
      <state>received</state>
      <state_date>2015-05-13</state_date>
      <derival>
         <city>Москва</city>
         <address>129345, Москва г, Магаданская ул, дом № 1</address>
         <city_code>7700000000000000000000000</city_code>
         <address_code>7700000000017620000000000</address_code>
         <terminal_name>Москва-Запад</terminal_name>
         <terminal_address>119361, Москва г, Очаковская М. ул, дом № 4</terminal_address>
         <terminal_id>18</terminal_id>
      </derival>
      <arrival>
         <city>Омск</city>
         <address>644027, Омская обл, Омск г, 20 лет РККА ул, дом № 302, литера А</address>
         <city_code>5500000100000000000000000</city_code>
         <address_code>5500000100006380000000000</address_code>
         <terminal_name>Омск</terminal_name>
         <terminal_address>644027, Омская обл, Омск г, 20 лет РККА ул, дом № 302, литера А</terminal_address>
         <terminal_id>53</terminal_id>
      </arrival>
      <sender>
         <opf>ООО</opf>
         <opf_uid>0x92ee033543fsdff9910cd87ca9ca</opf_uid>
         <name>ООО "АНТИЧНЫЙ ДВОР"</name>
         <address>109382, Москва г, Армавирская ул, дом № 1</address>
         <is_physical>false</is_physical>
         <inn>7842463725</inn>
         <document_type />
         <document_series />
         <document_number />
         <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
      </sender>
      <receiver>
         <opf>ООО</opf>
         <opf_uid>0x92ee03691543sdfs9910cd87ca9ca</opf_uid>
         <name>ИП "Пушкин Юрий Геннадьевич"</name>
         <address>Омская обл, Омск г, 10 лет Октября ул, дом № 180</address>
         <is_physical>true</is_physical>
         <inn></inn>
         <document_type>Паспорт РФ</document_type>
         <document_series />
         <document_number />
         <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
      </receiver>
      <payer>
         <opf>ООО</opf>
         <opf_uid>0x92ee0534sdfdfdsfcd87ca9ca</opf_uid>
         <name>ООО "АНТИЧНЫЙ ДВОР"</name>
         <is_physical>false</is_physical>
         <inn>7842463725</inn>
         <document_type />
         <document_series />
         <document_number />
         <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
      </payer>
      <freight>
         <name>МЕБЕЛЬ</name>
         <weight>1.0</weight>
         <oversized_weight>0.0</oversized_weight>
         <volume>1.0</volume>
         <oversized_volume>0.0</oversized_volume>
         <places>1</places>
         <oversized_places>0</oversized_places>
         <length>0.0</length>
         <width>0.0</width>
         <height>0.0</height>
      </freight>
      <air>
         <order_id />
         <comment />
         <delivery_date />
      </air>
      <locks>
         <name>Долг</name>
         <type>by_payment</type>
         <set_date>2015-05-12 16:38:38</set_date>
         <end_date />
      </locks>
      <total_sum>3480.0</total_sum>
      <is_paid>false</is_paid>
      <is_preorder>true</is_preorder>
      <ordered_delivery_from_address>true</ordered_delivery_from_address>
      <available_delivery_from_address>false</available_delivery_from_address>
      <ordered_delivery_to_address>true</ordered_delivery_to_address>
      <available_delivery_to_address>false</available_delivery_to_address>
      <is_favorite>false</is_favorite>
      <is_air>false</is_air>
      <estimated_delivery_date />
      <arrival_date />
      <giveout_date />
      <warehousing_date />
      <produce_date>2015-05-14</produce_date>
      <order_dates>
         <arrival_to_receiver>2016-04-01</arrival_to_receiver>
         <arrival_to_osp_sender>2016-04-01</arrival_to_osp_sender>
         <arrival_to_osp_receiver_accdoc>2016-04-01</arrival_to_osp_receiver_accdoc>
         <first_document_created_date>2016-04-01</first_document_created_date>
         <draft_last_update>2016-04-01</draft_last_update>
         <arrival_to_osp_receiver>2016-04-01</arrival_to_osp_receiver>
         <processing_date>2016-06-27</processing_date>
         <derival_from_osp_receiver_accdoc>2016-04-01</derival_from_osp_receiver_accdoc>
         <derival_from_osp_receiver>2016-04-01</derival_from_osp_receiver>
         <warehousing>2016-04-01</warehousing>
         <decline_date>2016-04-01</decline_date>
         <pickup>2016-04-01</pickup>
         <finish>2016-04-01</finish>
      </order_dates>
      <order_time_in_days>
         <delivery>2</delivery>
         <delivery_accdoc>2</delivery_accdoc>
      </order_time_in_days>
   </orders>
   <deleted>3956984</deleted>
   <deleted>3956289</deleted>
   <deleted>3955733</deleted>
   <metadata>
      <next_page>2</next_page>
      <current_page>1</current_page>
      <total_pages>74</total_pages>
      <prev_page />
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
</response>

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

Response
ПараметрТипОписание
ordersarray of Response.OrdersМассив найденных заказов
deletedarray of stringСписок удаленных заказов при передаче параметра "lastupdate"
metadataobjectМетаданные ответа API
metadata.next_pageinteger

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

metadata.current_pageintegerНомер текущей страницы ответа
metadata.total_pagesintegerКоличество страниц в ответе
metadata.prev_pageintegerНомер предыдущей страницы ответа (Если номер текущей страницы ответа - "1", то значение данного параметра - "null")
metadata.generated_atstringДата и время формирования ответа

Response.Orders
ПараметрТипОписание
idstringНомер заказа
ordered_atstringДата создания заказа
statestringСтатус заказа из "Справочника статусов заказа груза"
state_datestring

Дата применения текущего статуса

derival
objectИнформация о месте отправки
derival.citystringГород (выводится в форматах "default" и "full")
derival.addressstringАдрес (выводится в форматах "default" и "full")
derival.city_codestringКод КЛАДР города (выводится в форматах "idly" и "full")
derival.address_codestringКод КЛАДР улицы (выводится в форматах "idly" и "full")
derival.terminal_namestringНазвание терминала (выводится в форматах "default" и "full")
derival.terminal_addressstringАдрес терминала (выводится в форматах "default" и "full")
derival.terminal_idintegerID терминала из "Справочника терминалов" (выводится в форматах "idly" и "full")
arrivalobject

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

Параметры объекта "arrival" аналогичны параметрам объекта "derival".
sender
objectИнформация об отправителе
sender.opfstringОПФ (выводится в форматах "default" и "full")
sender.opf_uidstringUID ОПФ из "Cправочника ОПФ" (выводится в форматах "idly" и "full")
sender.namestringНаименование контрагента (выводится в форматах "default" и "full")
sender.addressstringАдрес контрагента (выводится в форматах "default" и "full")
sender.is_physicalbooleanФлаг "Физическое лицо" (выводится в форматах "default" и "full")
sender.innstringИНН юр. лица (выводится в форматах "default" и "full")
sender.document_typestring

Вид документа физ. лица (выводится в форматах "default" и "full")

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

  • "Паспорт РФ"
  • "Загранпаспорт"
  • "Водительское удостоверение"
sender.document_seriesstringСерия документа физ. лица (выводится в форматах "default" и "full")
sender.document_numberstringНомер документа физ. лица (выводится в форматах "default" и "full")
sender.counteragent_uidstringUID контрагента (выводится в форматах "idly" и "full")
receiverobject

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

Параметры объекта "receiver" аналогичны параметрам объекта "sender".
payerobject

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

Параметры объекта "payer" аналогичны параметрам объекта "sender".
freight
objectИнформация о грузе
freight.namestringХарактер груза
freight.weightstringВес груза
freight.oversized_weightstringНегабаритный вес
freight.volumestringОбъем груза
freight.oversized_volumestringНегабаритный объем
freight.placesintegerКоличество грузовых мест
freight.oversized_placesintegerКоличество негабаритных мест
freight.lengthstringДлина груза
freight.widthstringШирина груза
freight.heightstringВысота груза
airobjectИнформация о доставке авиатранспортом (при отсутствии возвращается пустой объект)
air.order_idstringНомер авианакладной
air.commentstringКомментарий
air.delivery_datestringДата прибытия
locksarray of Response.Orders.LocksМассив блокировок
documents
array of Response.Orders.DocumentsМассив документов заказа (при отсутствии возвращается пустой массив). Примеры этого блока для разных документов рассмотрены в разделе ""
total_sumstringОбщая сумма заказа
is_paidbooleanСтатус оплаты заказа
is_preorderbooleanФлаг, обозначающий что заказ является предзаказом
ordered_delivery_from_addressbooleanФлаг, обозначающий что заказана доставка от адреса отправителя
available_delivery_from_addressbooleanФлаг, обозначающий что возможна доставка от адреса отправителя
ordered_delivery_to_addressbooleanФлаг, обозначающий что заказана доставка до адреса получателя
available_delivery_to_addressbooleanФлаг, обозначающий что возможна доставка до адреса получателя
is_favoritebooleanПризнак избранного заказа
is_airbooleanПризнак авиадоставки
estimated_delivery_datestringОриентировочная дата прибытия груза (если значения параметров: "state" = "inway", "is_air" = "true". В противном случае значение данного параметра = "null")
arrival_datestringДата прибытия груза (если значение параметра "is_air" = "true". В противном случае значение данного параметра = "null")
giveout_datestringДата выдачи груза (если значение параметра "is_air" = "true". В противном случае значение данного параметра = "null")
warehousing_datestringДата начала платного хранения
produce_datestringДата выполнения заказа (если значение параметра "is_air" = "true")
order_datesobjectРасчетный график движения груза (если значение параметра "is_air" = "false". В противном случае значения всех параметров данного объекта будут содержать "null")
order_dates.arrival_to_receiverstringДата доставки груза до адреса
order_dates.arrival_to_osp_senderstring

Дата прибытия груза на терминал-отправитель

order_dates.arrival_to_osp_receiver_accdocstring

Дата прибытия сопроводительных документов на терминал-получатель

order_dates.first_document_created_datestring

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

order_dates.draft_last_updatestringДата последнего сохранения черновика
order_dates.arrival_to_osp_receiverstring

Дата прибытия груза на терминал-получатель

order_dates.processing_datestringДата отправки заявки в обработку
order_dates.derival_from_osp_receiver_accdocstring

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

order_dates.derival_from_osp_receiverstringДата отправки из терминала-получателя
order_dates.warehousingstringДата начала платного хранения
order_dates.decline_datestringДата отклонения
order_dates.pickupstringДата забора груза от адреса
order_dates.finishstringДата исполнения заказа
order_time_in_daysobjectРасчетные сроки доставки в днях (если значение параметра "is_air" = "false". В противном случае значения всех параметров данного объекта будут содержать "null")
order_time_in_days.deliveryintegerСрок доставки до адреса, дн.
order_time_in_days.delivery_accdocintegerСрок доставки сопроводительных документов до адреса, дн.

Response.Orders.Locks
ПараметрТипОписание
namestringНаименование блокировки
typestringТип блокировки
set_datestringДата установки блокировки
end_datestringДата снятия блокировки

Если получатель груза является анонимным получателем, то объект "Respone.Orders.Receiver" будет содержать следующие параметры:

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

{  
   "opf":"ЧЛ",
   "opf_uid":"0xAB91FEEA04F6D4AD48DF42161B6C2E7A",
   "name":"Петрович",
   "address":"Омская обл, Омск г, 10 лет Октября ул, дом № 180",
   "is_physical":true,
   "is_anonym":true,
   "Phone":"+7 (900) 000-00-00",
   "Email":"petro@mail.com",
   "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
}
<receiver>
   <opf>ЧЛ</opf>
   <opf_uid>0xAB91FEEA04F6D4AD48DF42161B6C2E7A</opf_uid>
   <name>Петрович</name>
   <address>Омская обл, Омск г, 10 лет Октября ул, дом № 180</address>
   <is_physical>true</is_physical>
   <is_anonym>true</is_anonym>
   <phone>+7 (900) 000-00-00</phone>
   <email>petro@mail.com</email>
   <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
</receiver>

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

Response.Orders.Receiver
ПараметрТипОписание
opfstringОПФ (выводится в форматах "default" и "full")
opf_uidstringUID ОПФ из "Cправочника ОПФ" (выводится в форматах "idly" и "full")
namestringНаименование получателя (выводится в форматах "default" и "full")
addressstringАдрес получателя (выводится в форматах "default" и "full")
is_physicalbooleanФлаг "Физическое лицо" (выводится в форматах "default" и "full")
is_anonymbooleanПризнак контрагента с минимальным набором данных для УО (АП)
phonestringНомер телефона АП
emailstringАдрес элктронной почты АП
counteragent_uidstringUID контрагента (выводится в форматах "idly" и "full")

Документы в заказе

Документы, связанные с заказом, возвращаются в блоке "documents". Рассмотрим примеры этого блока для возможных типов документов:

  •  заявка на доставку от адреса (предзаказ):

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

{  
   "document_type":"request",
   "document_id":3956403,
   "sender":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null
   },
   "receiver":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null
   },
   "payer":{  
      "opf":null,
      "opf_uid":"",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":null,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null
   },
   "derival":{  
      "name":"Москва",
      "code":7700000000000000000000000
   },
   "arrival":{  
      "name":"Омск",
      "code":5500000100000000000000000
   },
   "state":"accepted",
   "freight":{  
      "name":"мебель",
      "weight":1.0,
      "oversized_weight":null,
      "volume":1.0,
      "oversized_volume":null,
      "max_length":1.0,
      "max_width":1.0,
      "max_height":1.0
   },
   "create_date":"2015-05-13 14:20:05",
   "produce_date":"2015-05-14",
   "forwarder_id":"00083199252",
   "barcode":"4150846040100012600000015"
}
<documents>
   <document_type>request</document_type>
   <document_id>3956403</document_id>
   <sender>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
   </sender>
   <receiver>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
   </receiver>
   <payer>
      <opf />
      <opf_uid></opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical />
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
   </payer>
   <derival>
      <name>Москва</name>
      <code>7.7e+24</code>
   </derival>
   <arrival>
      <name>Омск</name>
      <code>5.5000001e+24</code>
   </arrival>
   <state>accepted</state>
   <freight>
      <name>мебель</name>
      <weight>1</weight>
      <oversized_weight />
      <volume>1</volume>
      <oversized_volume />
      <max_length>1</max_length>
      <max_width>1</max_width>
      <max_height>1</max_height>
   </freight>
   <create_date>2015-05-13 14:20:05</create_date>
   <produce_date>2015-05-14</produce_date>
   <forwarder_id>00083199252</forwarder_id>
   <barcode>4150846040100012600000015</barcode>
</documents>

 

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

Response.Orders.Documents
ПараметрТипОписание
document_typestring

Тип документа ("request" - заявка на доставку от адреса отправителя; "request_sf" - заявка на доставку до адреса получателя)

document_idintegerНомер документа (в данном случае - заявки)
senderobject

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

Параметры объекта "sender" описаны в таблице параметров объекта Response.Orders 
receiverobject

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

Параметры объекта "receiver" аналогичны параметрам объекта "sender", описанным в таблице параметров объекта Response.Orders
payerobject

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

Параметры объекта "payer" аналогичны параметрам объекта "sender", описанным в таблице параметров объекта Response.Orders 
derival
objectИнформация о месте отправки
derival.namestringГород
derival.codeintegerКод КЛАДР города 
arrivalobject

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

Параметры объекта "arrival" аналогичны параметрам объекта "derival".
statestring

Статус заявки.

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

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

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

freight.namestringХарактер груза
freight.weightfloatВес груза
freight.oversized_weightfloatНегабаритный вес
freight.volumefloatОбъем груза
freight.oversized_volumefloatНегабаритный объем
freight.max_lengthfloatДлина груза
freight.max_widthfloatШирина груза
freight.max_heightfloatВысота груза
create_datestringДата создания заявки
produce_datestringДата исполнения заявки
forwarder_idstringНомер заявки экспедитора
barcodestringBarcode для формирования штрихкода по алгоритму Code 128 (для заявки на предзаказ)
  • заявка на доставку до адреса:

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

{  
   "document_type":"request_sf",
   "document_id":3000653,
   "sender":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":null
   },
   "receiver":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":null
   },
   "payer":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":null
   },
   "state":"loaded",
   "create_date":"2015-05-13 14:28:02",
   "produce_date":"2015-05-15",
   "forwarder_id":"00393009651"
}
<documents>
   <document_type>request_sf</document_type>
   <document_id>3000653</document_id>
   <sender>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid />
   </sender>
   <receiver>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid />
   </receiver>
   <payer>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid />
   </payer>
   <state>loaded</state>
   <create_date>2015-05-13 14:28:02</create_date>
   <produce_date>2015-05-15</produce_date>
   <forwarder_id>00393009651</forwarder_id>
</documents>
Описание параметров документа "Заявка на доставку до адреса" соответствует описанию аналогичных параметров документа "Заявка на доставку от адреса (предзаказ)".
  • накладная (межтерминальная перевозка): 

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

{  
   "document_type":"shipping",
   "document_id":"15-00025043954",
   "document_uid":"0x80caf72943b434fc4e2e302561ac1dec",
   "sender":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
   },
   "receiver":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
   },
   "payer":{  
      "opf":"ООО",
      "opf_uid":"0x92ee03691f25a9fe4be9910cd87ca9ca",
      "name":"ООО \"АНТИЧНЫЙ ДВОР\"",
      "is_physical":false,
      "inn":"7842463725",
      "document_type":null,
      "document_series":null,
      "document_number":null,
      "counteragent_uid":"345abec97-f62b-f6f5-dc4a-d2d283451d78fa4"
   },
   "derival":{  
      "name":"Москва",
      "code":7700000000000000000000000
   },
   "arrival":{  
      "name":"Омск",
      "code":5500000100000000000000000
   },
   "freight":{  
      "name":"МЕБЕЛЬ",
      "weight":1,
      "oversized_weight":0,
      "volume":1.0,
      "oversized_volume":0.0,
      "max_length":0.0,
      "max_width":0.0,
      "max_height":0.0
   },
   "state":"in_way",
   "payment":false,
   "total_sum":3480.0,
   "debt_sum":"3480.0",
   "create_date":"2015-05-13 17:21:56",
   "service_kind":"Авто",
   "services":[  
      {  
         "name":"Перевозка автотранспортная",
         "service_uid":"0xa8e38733915fd9844f1cd8de0a9beb4e",
         "created_at":"2015-05-13 11:23:21",
         "quantity":1,
         "sum":"3380.0",
         "discount_sum":"0.0",
         "total_sum":"3380.0"
      },
      {  
         "name":"Въезд на наш терминал-отправитель",
         "service_uid":"0xb1da8f1ec1b774ec45152fc5643aa598",
         "created_at":"2015-05-13 11:23:21",
         "quantity":1,
         "sum":"100.0",
         "discount_sum":"0.0",
         "total_sum":"100.0"
      }
   ],
   "accompanying_documents":[  
      {  
         "document_date":"2015-08-21",
         "document_number":"11111",
         "document_kind":"Текст комментария"
      }
   ],
   "available_docs":[  
      "order",
      "bill"
   ]
}
<documents>
   <document_type>shipping</document_type>
   <document_id>15-00025043954</document_id>
   <document_uid>0x80caf72943b434fc4e2e302561ac1dec</document_uid>
   <sender>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
   </sender>
   <receiver>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
   </receiver>
   <payer>
      <opf>ООО</opf>
      <opf_uid>0x92ee03691f25a9fe4be9910cd87ca9ca</opf_uid>
      <name>ООО "АНТИЧНЫЙ ДВОР"</name>
      <is_physical>false</is_physical>
      <inn>7842463725</inn>
      <document_type />
      <document_series />
      <document_number />
      <counteragent_uid>345abec97-f62b-f6f5-dc4a-d2d283451d78fa4</counteragent_uid>
   </payer>
   <derival>
      <name>Москва</name>
      <code>7.7e+24</code>
   </derival>
   <arrival>
      <name>Омск</name>
      <code>5.5000001e+24</code>
   </arrival>
   <freight>
      <name>МЕБЕЛЬ</name>
      <weight>1</weight>
      <oversized_weight>0</oversized_weight>
      <volume>1</volume>
      <oversized_volume>0</oversized_volume>
      <max_length>0</max_length>
      <max_width>0</max_width>
      <max_height>0</max_height>
   </freight>
   <state>in_way</state>
   <payment>false</payment>
   <total_sum>3480</total_sum>
   <debt_sum>3480.0</debt_sum>
   <create_date>2015-05-13 17:21:56</create_date>
   <service_kind>Авто</service_kind>
   <services>
      <name>Перевозка автотранспортная</name>
      <service_uid>0xa8e38733915fd9844f1cd8de0a9beb4e</service_uid>
      <created_at>2015-05-13 11:23:21</created_at>
      <quantity>1</quantity>
      <sum>3380.0</sum>
      <discount_sum>0.0</discount_sum>
      <total_sum>3380.0</total_sum>
   </services>
   <services>
      <name>Въезд на наш терминал-отправитель</name>
      <service_uid>0xb1da8f1ec1b774ec45152fc5643aa598</service_uid>
      <created_at>2015-05-13 11:23:21</created_at>
      <quantity>1</quantity>
      <sum>100.0</sum>
      <discount_sum>0.0</discount_sum>
      <total_sum>100.0</total_sum>
   </services>
   <accompanying_documents>
      <document_date>2015-08-21</document_date>
      <document_number>11111</document_number>
      <document_kind>Текст комментария</document_kind>
   </accompanying_documents>
   <available_docs>order</available_docs>
   <available_docs>bill</available_docs>
</documents>

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

Response.Orders.Documents
ПараметрТипОписание
document_typestring

Тип документа ("shipping" - накладная)

document_idstringНомер документа (в данном случае - накладной)
document_uidstringUID накладной
senderobject

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

Параметры объекта "sender" описаны в таблице параметров объекта Response.Orders
receiverobject

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

Параметры объекта "receiver" аналогичны параметрам объекта "sender", описанным в таблице параметров объекта Response.Orders
payerobject

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

Параметры объекта "payer" аналогичны параметрам объекта "sender", описанным в таблице параметров объекта Response.Orders 
derivalobject

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

arrivalobject

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

Параметры объекта "arrival" аналогичны параметрам объекта "derival", описанным в таблице параметров для документа "Заявка на доставку от адреса (предзаказ)" 
freightobject

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

freight.namestringХарактер груза
freight.weightfloatВес груза
freight.oversized_weightfloatНегабаритный вес
freight.volumefloatОбъем груза
freight.oversized_volumefloatНегабаритный объем
freight.max_lengthfloatДлина груза
freight.max_widthfloatШирина груза
freight.max_heightfloatВысота груза
statestring

Статус накладной.

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

  • "in_way" - в пути
  • "arrival" - прибыла
  • "give_out" - выдана
paymentbooleanCтатус оплаты
total_sumfloatОбщая сумма по накладной
debt_sumstringСумма долга
create_datestringДата создания накладной
service_kindstringТип перевозки
servicesarray of Response.Orders.Documents.ServicesПеречень услуг по накладной

accompanying_documents

array of Response.Orders.Documents.Accompanying_documentsПеречень сопроводительных документов
available_docsarray of stringПеречень документов, по которым можно получить печатные формы

 

Response.Orders.Documents.Services
ПараметрТипОписание
namestringНаименование услуги
service_uidstringUID услуги
created_atstringДата создания
quantityintegerКоличество
sumstringСумма
discount_sumstringСумма скидки
total_sumstringСумма итого

 

Response.Orders.Documents.Accompanying_documents
ПараметрТипОписание
document_datestringДата создания сопроводительного документа
document_numberstringНомер сопроводительного документа
document_kindstringКомментарий

Избранные заказы 

Для избранных заказов в ответе возвращается только часть информации: 

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

{  
   "orders":[  
      {  
         "id":"1505345323345",
         "state":"inway",
         "derival":{  
            "city":"Санкт-Петербург",
            "city_code":"7700000000000000000000000"
         },
         "arrival":{  
            "city":"Москва",
            "city_code":"5500000100000000000000000"
         },
         "sender":{  
            "access":false
         },
         "receiver":{  
            "access":false
         },
         "freight":{  
            "access":false
         },
         "documents":[  
            {  
               "state":"in_way",
               "produce_date":null,
               "payer":{  
                  "access":false
               },
               "total_sum":3060.0,
               "services":[  
                  {  
                     "name":"Перевозка автотранспортная"
                  },
                  {  
                     "name":"Въезд на терминал-получатель"
                  }
               ],
               "document_type":"shipping",
               "document_id":"15-01905000217"
            }
         ],
         "locks":[  
            {  
               "type":"by_payment",
               "name":"Долг"
            }
         ],
         "produce_date":null,
         "state_date":"2015-07-24",
         "arrival_date":null,
         "giveout_date":null,
         "warehousing_date":null,
         "is_favorite":true
      }
   ],
   "metadata":{  
      "generated_at":"2015-07-24 12:10:34",
      "next_page":null,
      "current_page":1,
      "total_pages":1,
      "prev_page":null
   }
}
<response>
   <orders>
      <id>1505345323345</id>
      <state>inway</state>
      <derival>
         <city>Санкт-Петербург</city>
         <city_code>7700000000000000000000000</city_code>
      </derival>
      <arrival>
         <city>Москва</city>
         <city_code>5500000100000000000000000</city_code>
      </arrival>
      <sender>
         <access>false</access>
      </sender>
      <receiver>
         <access>false</access>
      </receiver>
      <freight>
         <access>false</access>
      </freight>
      <documents>
         <state>in_way</state>
         <produce_date />
         <payer>
            <access>false</access>
         </payer>
         <total_sum>3060</total_sum>
         <services>
            <name>Перевозка автотранспортная</name>
         </services>
         <services>
            <name>Въезд на терминал-получатель</name>
         </services>
         <document_type>shipping</document_type>
         <document_id>15-01905000217</document_id>
      </documents>
      <locks>
         <type>by_payment</type>
         <name>Долг</name>
      </locks>
      <produce_date />
      <state_date>2015-07-24</state_date>
      <arrival_date />
      <giveout_date />
      <warehousing_date />
      <is_favorite>true</is_favorite>
   </orders>
   <metadata>
      <generated_at>2015-07-24 12:10:34</generated_at>
      <next_page />
      <current_page>1</current_page>
      <total_pages>1</total_pages>
      <prev_page />
   </metadata>
</response>
Параметр "access" (тип - "boolean") - флаг "Доступ к информации в этом блоке закрыт".Остальные параметры ответа для избранных заказов аналогичны параметрам ответа для заказов, не добавленных в избранное (см. описание в соответствующем разделе).Параметры блока "documents" описаны в разделе "Документы в заказе".