Журнал заказов
Общие сведения
Сервис позволяет получать актуальную информацию о заказах, используя номер заказа компании "Деловые Линии", номер накладной или заявки, внутренний номер заказа интернет-магазина или штрих-код документа. Авторизованные пользователи при помощи данного метода также могут получить журнал отправок личного кабинета, в том числе актуальные статусы заказов, заявок и накладных.
Для идентификации состава ответа используется входящий параметр "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", "cargoPlaces":[ "3252235" ], "shipmentLabelCargoPlace":"Артикул1223657", "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> <cargoPlaces>3252235</cargoPlaces> <shipmentLabelCargoPlace>Артикул1223657</shipmentLabelCargoPlace> <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 strings | Номер заказа, накладной или заявки. Возможна передача нескольких параметров. Максимум может быть передано 5 значений. *Параметр используется для поиска заказа. Если в запросе отсутствует параметр "sessionID", то в нём должен присутствовать один из следующих параметров: "docIds", "orderNumber" или "barcode" В запросе может быть передан только один из параметров: "docIds", "orderNumber", "barcode", "cargoPlaces", "shipmentLabelCargoPlace" |
orderNumber | Нет* | string | Номер заказа интернет-магазина (внутренний номер заказа, ВНЗ). *Параметр используется для поиска заказа. Если в запросе отсутствует параметр "sessionID", то в нём должен присутствовать один из следующих параметров: "docIds", "orderNumber" или "barcode" В запросе может быть передан только один из параметров: "docIds", "orderNumber", "barcode", "cargoPlaces", "shipmentLabelCargoPlace" |
orderDate | Нет | string | Дата заказа интернет-магазина. Формат: "ГГГГ-ММ-ДД" |
barcode | Нет* | string | Штрих-код, считанный сканером. Для поиска заказа могут быть использованы следующие штрих-коды:
*Параметр используется для поиска заказа. Если в запросе отсутствует параметр "sessionID", то в нём должен присутствовать один из следующих параметров: "docIds", "orderNumber" или "barcode" В запросе может быть передан только один из параметров: "docIds", "orderNumber", "barcode", "cargoPlaces", "shipmentLabelCargoPlace" |
cargoPlaces | Нет* | array of strings | Массив номеров грузовых мест. *Параметр используется для поиска заказа авторизованными пользователями (может быть передан, только если в запросе присутствует параметр "sessionID"). В запросе может быть передан только один из параметров: "docIds", "orderNumber", "barcode", "cargoPlaces", "shipmentLabelCargoPlace" Поиск производится только по первому значению, переданному в массиве |
shipmentLabelCargoPlace | Нет* | string | Артикул грузового места. *Параметр используется для поиска заказа авторизованными пользователями (может быть передан, только если в запросе присутствует параметр "sessionID"). Чтобы иметь возможность искать заказы по артикулу грузового места, необходимо сначала передать информацию о грузовых местах при помощи метода "Передача артикулов грузовых мест". Пользователи с ограниченным доступом могут осуществлять поиск только по тем заказам, где они выступают в роли заказчика, пользователи с полным доступом - по всем заказам, независимо от роли (подробнее о доступе см. метод "Список контрагентов", описание параметра ответа "info.accessLevel"). Если заказана доставка груза от адреса отправителя и груз ещё не был принят к перевозке на терминале компании, то информация по грузу доступна только тому пользователю, который оформил заказ В запросе может быть передан только один из параметров: "docIds", "orderNumber", "barcode", "cargoPlaces", "shipmentLabelCargoPlace" |
dateStart | Нет | string | Начальная дата и время периода (для фильтрации результатов поиска по периоду создания заказа). Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС". Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docIds", "orderNumber", "barcode", "cargoPlaces" или "shipmentLabelCargoPlace" |
dateEnd | Нет | string | Конечная дата и время периода (для фильтрации результатов поиска по периоду создания заказа. Учитывается при указании параметра "dateStart"). Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС". Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docIds", "orderNumber", "barcode", "cargoPlaces" или "shipmentLabelCargoPlace" |
states | Нет | array of strings | Список статусов, заказы с которыми надо получить в ответе. Статусы указываются на основании "Справочника статусов заказа груза". Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docIds", "orderNumber", "barcode", "cargoPlaces" или "shipmentLabelCargoPlace" |
page | Нет | integer | Номер запрашиваемой страницы ответа |
lastUpdate | Нет | string | Фильтр для поиска заказов, изменившихся в период, начиная с указанного в данном параметре момента времени. Формат: "ГГГГ-ММ-ДД ЧЧ:ММ:СС". Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docIds", "orderNumber", "barcode", "cargoPlaces" или "shipmentLabelCargoPlace". Если в запросе передан параметр "states" со значением "inway", то в ответ будут включены все заказы в статусе "inway", не зависимо от значения параметра "lastUpdate" (для прочих статусов действует иная логика - в ответ включаются заказы в указанных статусах, обновлённые после даты, переданной в параметре "lastUpdate") |
orderBy | Нет | string | Сортировка заказов. Возможные значения:
Значение параметра учитывается, только если в запросе есть параметр "sessionID", но нет параметров "docIds", "orderNumber", "barcode", "cargoPlaces" или "shipmentLabelCargoPlace" |
orderDatesAdditional | Нет | boolean | Флаг, обозначающий, что необходима информация о промежуточных точках маршрута перевозки |
Ответ метода
Структура ответа
{ "metadata":{ "status":200, "currentPage":1, "nextPage":null, "prevPage":null, "totalPages":1, "generatedAt":"2020-10-01 13:24:54" }, "orders":[ { "orderNumber":null, "orderDate":null, "orderId":"400275691", "orderedAt":"2020-10-01 08:36:27", "state":"inway", "stateName":"Груз в пути", "stateDate":"2020-10-01", "returnState":true, "returnReason":"Отказ после выдачи", "returnDate":"2020-10-15 12:30:17", "progressPercent":15, "derival":{ "city":"г. Санкт-Петербург", "cityId":1, "cityCode":"7800000000000000000000000", "address":"190000, Санкт-Петербург г, Заневский пр-кт, дом № 1", "addressCode":"7800000000004380000000000", "terminalName":"Санкт-Петербург Парнас", "terminalAddress":"194292, Санкт-Петербург г, 1-й Верхний пер, дом № 12, Литера Б", "terminalId":1 }, "arrival":{ "city":"г. Москва", "cityId":3, "cityCode":"7700000000000000000000000", "address":"127411, Москва г, Лобненская ул, дом № 18, стр 2", "addressCode":"7700000000017250000000000", "terminalName":"Москва Север 2", "terminalAddress":"127411, Москва г, Лобненская ул, дом № 18, стр 2", "terminalId":36, "terminalCity":"Москва", "terminalCoordinates":[ 37.5192, 55.8967 ], "terminalEmail":"pismo@dellin.ru ", "terminalPhones":"7 (495) 775-55-30", "callCenterPhones":"8-800-100-8000", "terminalWorktables":{ "sun":"11:00-16:00", "mon":"08:00-22:00", "tue":"08:00-22:00", "wed":"08:00-22:00", "thu":"08:00-22:00", "fri":"08:00-22:00", "sat":"11:00-16:00" }, "specialWorktable":{ "receive":[ "27 ноября — выходной", "28 ноября — с 10:00 до 15:00", "29–30 ноября — выходные" ], "giveout":[ "27 ноября — выходной", "28 ноября — с 10:00 до 15:00", "29–30 ноября — выходные" ] } }, "sender":{ "opf":{ "name":"ООО", "fullName":"Общество с Ограниченной Ответственностью", "countryCode":643 }, "opfUid":"0xa8123a457e644fe7435605b8f632f9d3", "name":"ООО \"Анкоррес Электро\"", "address":"190000, Санкт-Петербург г, Заневский пр-кт, дом № 2", "isPhysical":false, "inn":"192644882", "documentType":null, "documentSeries":null, "documentNumber":null, "counteragentUid":"e0a79552-bcf4-4ca2-bb5b-961bd2c0f9a2", "contacts":"Валерий", "phones":"+7 (921) 333-22-22" }, "receiver":{ "opf":{ "name":"ООО", "fullName":"Общество с Ограниченной Ответственностью", "countryCode":643 }, "opfUid":"0xa8123a457e644fe7435605b8f632f9d3", "name":"ООО \"ДД МЕДИКА\"", "address":"127411, Москва г, Лобненская ул, дом № 12, стр 2", "isPhysical":false, "inn":"7710647612", "documentType":null, "documentSeries":null, "documentNumber":null, "counteragentUid":"b2763d61-e1b3-4c26-b46a-b3c95875a9c2", "anonym":false, "anonymPhone":null, "anonymEmail":null }, "payer":{ "opf":{ "name":"ООО", "fullName":"Общество с Ограниченной Ответственностью", "countryCode":643 }, "opfUid":"0xa8123a457e644fe7435605b8f632f9d3", "name":"ООО \"Анкоррес Электро\"", "isPhysical":false, "inn":"192644882", "documentType":null, "documentSeries":null, "documentNumber":null, "counteragentUid":"e0a79552-bcf4-4ca2-bb5b-961bd2c0f9a2" }, "freight":{ "name":"Мебель", "weight":"2.0", "oversizedWeight":"0.0", "volume":"2.0", "oversizedVolume":"0.0", "places":1, "oversizedPlaces":0, "length":"0.0", "width":"0.0", "height":"0.0" }, "cargoPlaces":[ { "number": "3252235", "amount": 1 } ], "isAir":false, "air":{ "arrivalDate":"2020-10-01", "giveoutDate":"2020-10-01", "warehousingDate":"2020-10-06", "deliveryDate":"2020-10-01", "comment":"комментарий", "orderId":"123-12312323" }, "locks":[ { "name":"Долг", "type":"by_payment", "setDate":"2020-10-01 11:51:47", "endDate":null } ], "webOrderItemsSum":null, "withWebOrder":true, "totalSum":"7644.0", "vat":"1171.33", "isPaid":false, "isPreorder":false, "produceDate":"2020-10-10", "declineReason":null, "orderDates":{ "arrivalToOspReceiver":"2020-10-14", "arrivalToOspReceiverMax":null, "arrivalToOspReceiverAccdoc":null, "arrivalToOspSender":null, "arrivalToReceiver":null, "declineDate":null, "derivalFromOspReceiver":null, "derivalFromOspReceiverMax":null, "derivalFromOspReceiverAccdoc":null, "giveoutFromOspReceiver":null, "giveoutFromOspReceiverMax":null, "derivalFromOspSender":"2020-10-13 00:00:00", "draftLastUpdate":null, "finish":null, "firstDocumentCreatedDate":"2020-10-01", "pickup":"2020-10-10 00:00:00", "processingDate":null, "warehousing":null }, "orderTimeInDays":{ "delivery":null, "deliveryAccdoc":null }, "orderedDeliveryFromAddress":true, "availableDeliveryFromAddress":false, "orderedDeliveryToAddress":true, "availableDeliveryToAddress":false, "isFavorite":false, "isContainer":false, "sfrequest":{ "cityID":200555, "docNumber":"20-00015100302", "price":"1490.0" }, "documents":[ { "id":400275691, "uid":null, "type":"request", "createDate":"2020-10-01 11:36:27", "state":"accepted", "sender":{ "opf":"ООО", "opfUid":"0xa8123a457e644fe7435605b8f632f9d3", "name":"Анкоррес Электро", "isPhysical":false, "inn":"192644883", "documentType":null, "documentSeries":null, "documentNumber":null, "counteragentUid":null }, "receiver":{ "opf":"ОАО", "opfUid":"0x8390b2048d37e0154b845fb22793e865", "name":"ДД-Мед", "isPhysical":false, "inn":"7710647613", "documentType":null, "documentSeries":null, "documentNumber":null, "counteragentUid":null }, "payer":{ "opf":null, "opfUid":"", "name":"Анкоррес Электро", "isPhysical":null, "inn":"192644882", "documentType":null, "documentSeries":null, "documentNumber":null, "counteragentUid":null }, "produceDate":"2020-10-10", "forwarderId":"00860733921", "comment":"комментарий к отправке", "fullDocumentId":"K-400275691", "freight":{ "name":"Мебель", "weight":0.1, "oversizedWeight":null, "volume":0.1, "oversizedVolume":null, "maxLength":0.1, "maxWidth":0.1, "maxHeight":0.1 }, "derival":{ "name":"Санкт-Петербург", "code":"7800000000000000000000000" }, "arrival":{ "name":"Москва", "code":"7700000000000000000000000" }, "barcode":null, "payment":null, "totalSum":null, "vat":null, "serviceKind":null, "organization":null, "services":[ ], "accompanyingDocuments":[ ], "availableDocs":[ ] }, { "id":"20-00015100302", "uid":"0x81f400505683df3d11eb03c3460a5915", "type":"shipping", "createDate":"2020-10-01 14:51:09", "state":"in way", "sender":{ "opf":null, "opfUid":"0xa8123a457e644fe7435605b8f632f9d3", "name":"ООО \"Анкоррес Электро\"", "isPhysical":false, "inn":"192644882", "documentType":null, "documentSeries":null, "documentNumber":null, "counteragentUid":"e0a79552-bcf4-4ca2-bb5b-961bd2c0f9a2" }, "receiver":{ "opf":"ООО", "opfUid":"0x92ee03691f25a9fe4be9910cd87ca9ca", "name":"ООО \"ДД МЕДИКА\"", "isPhysical":false, "inn":"7710647612", "documentType":null, "documentSeries":null, "documentNumber":null, "counteragentUid":"b2763d61-e1b3-4c26-b46a-b3c95875a9c2" }, "payer":{ "opf":null, "opfUid":"0xa8123a457e644fe7435605b8f632f9d3", "name":"ООО \"Анкоррес Электро\"", "isPhysical":false, "inn":"192644882", "documentType":null, "documentSeries":null, "documentNumber":null, "counteragentUid":"e0a79552-bcf4-4ca2-bb5b-961bd2c0f9a2" }, "produceDate":null, "forwarderId":null, "comment":null, "fullDocumentId":null, "freight":{ "name":"Мебель", "weight":2, "oversizedWeight":0, "volume":2.0, "oversizedVolume":0.0, "maxLength":0.0, "maxWidth":0.0, "maxHeight":0.0 }, "derival":{ "name":"Санкт-Петербург", "code":"7800000000000000000000000" }, "arrival":{ "name":"Москва", "code":"7700000000000000000000000" }, "barcode":null, "payment":false, "totalSum":"7644.0", "vat":"1171.33", "serviceKind":"Авто", "organization":"0x9efb0013cea09f3311dcd80f7091a6d0", "services":[ { "name":"Экспедирование до клиента", "serviceUid":"0xa191584309b83a6a4b5c253d4d6ec797", "createdAt":"2020-10-01 11:52:05", "quantity":1, "sum":"1490.0", "totalSum":"1490.0", "vat":"248.30", "vatRate":"20%", "discountSum":"0.0" } ], "accompanyingDocuments":[ ], "availableDocs":[ "order", "bill" ] } ], "orderDatesAdditional":{ "tracing":[ { "title":"Отбытие из ОСП", "date":"2020-10-01", "cityUID":"0x834f00112fdd658311da4c6326ef0e0e", "cityName":"Волгоград", "status":"inway" }, { "title":"Отбытие из ОСП", "date":"2019-10-01", "cityUID":"0x834f00112fdd658311da4c6326ef0e19", "cityName":"Уфа", "status":"inway" } ] }, "detailedStatus":null, "detailedStatusRus":null, "note":null, "documentsReturnDate":null, "priceComment":"", "customerUid":"00000000-0000-0000-0000-000000000000", "acceptanceActs":[ { "acceptanceActNumber":"5775757575", "acceptanceActDate":"2020-10-01", "acceptanceActType":"" }, { "acceptanceActNumber":"5775757575/111", "acceptanceActDate":"2020-10-02", "acceptanceActType":"Исправленный" } ], "shipmentLabelCargoPlace":"Артикул1223657" } ], "deleted":null }
<response> <metadata> <status>200</status> <currentPage>1</currentPage> <nextPage /> <prevPage /> <totalPages>1</totalPages> <generatedAt>2020-10-01 13:24:54</generatedAt> </metadata> <orders> <orderNumber /> <orderDate /> <orderId>400275691</orderId> <orderedAt>2020-10-01 08:36:27</orderedAt> <state>inway</state> <stateName>Груз в пути</stateName> <stateDate>2020-10-01</stateDate> <returnState>true</returnState> <returnReason>Отказ после выдачи</returnReason> <returnDate>2020-10-15 12:30:17</returnDate> <progressPercent>15</progressPercent> <derival> <city>г. Санкт-Петербург</city> <cityId>1</cityId> <cityCode>7800000000000000000000000</cityCode> <address>190000, Санкт-Петербург г, Заневский пр-кт, дом № 1</address> <addressCode>7800000000004380000000000</addressCode> <terminalName>Санкт-Петербург Парнас</terminalName> <terminalAddress>194292, Санкт-Петербург г, 1-й Верхний пер, дом № 12, Литера Б</terminalAddress> <terminalId>1</terminalId> </derival> <arrival> <city>г. Москва</city> <cityId>3</cityId> <cityCode>7700000000000000000000000</cityCode> <address>127411, Москва г, Лобненская ул, дом № 18, стр 2</address> <addressCode>7700000000017250000000000</addressCode> <terminalName>Москва Север 2</terminalName> <terminalAddress>127411, Москва г, Лобненская ул, дом № 18, стр 2</terminalAddress> <terminalId>36</terminalId> <terminalCity>Москва</terminalCity> <terminalCoordinates>37.5192</terminalCoordinates> <terminalCoordinates>55.8967</terminalCoordinates> <terminalEmail>pismo@dellin.ru </terminalEmail> <terminalPhones>7 (495) 775-55-30</terminalPhones> <callCenterPhones>8-800-100-8000</callCenterPhones> <terminalWorktables> <sun>11:00-16:00</sun> <mon>08:00-22:00</mon> <tue>08:00-22:00</tue> <wed>08:00-22:00</wed> <thu>08:00-22:00</thu> <fri>08:00-22:00</fri> <sat>11:00-16:00</sat> </terminalWorktables> <specialWorktable> <receive>27 ноября — выходной</receive> <receive>28 ноября — с 10:00 до 15:00</receive> <receive>29–30 ноября — выходные</receive> <giveout>27 ноября — выходной</giveout> <giveout>28 ноября — с 10:00 до 15:00</giveout> <giveout>29–30 ноября — выходные</giveout> </specialWorktable> </arrival> <sender> <opf> <name>ООО</name> <fullName>Общество с Ограниченной Ответственностью</fullName> <countryCode>643</countryCode> </opf> <opfUid>0xa8123a457e644fe7435605b8f632f9d3</opfUid> <name>ООО "Анкоррес Электро"</name> <address>190000, Санкт-Петербург г, Заневский пр-кт, дом № 2</address> <isPhysical>false</isPhysical> <inn>192644882</inn> <documentType /> <documentSeries /> <documentNumber /> <counteragentUid>e0a79552-bcf4-4ca2-bb5b-961bd2c0f9a2</counteragentUid> <contacts>Валерий</contacts> <phones>+7 (921) 333-22-22</phones> </sender> <receiver> <opf> <name>ООО</name> <fullName>Общество с Ограниченной Ответственностью</fullName> <countryCode>643</countryCode> </opf> <opfUid>0xa8123a457e644fe7435605b8f632f9d3</opfUid> <name>ООО "ДД МЕДИКА"</name> <address>127411, Москва г, Лобненская ул, дом № 12, стр 2</address> <isPhysical>false</isPhysical> <inn>7710647612</inn> <documentType /> <documentSeries /> <documentNumber /> <counteragentUid>b2763d61-e1b3-4c26-b46a-b3c95875a9c2</counteragentUid> <anonym>false</anonym> <anonymPhone /> <anonymEmail /> </receiver> <payer> <opf> <name>ООО</name> <fullName>Общество с Ограниченной Ответственностью</fullName> <countryCode>643</countryCode> </opf> <opfUid>0xa8123a457e644fe7435605b8f632f9d3</opfUid> <name>ООО "Анкоррес Электро"</name> <isPhysical>false</isPhysical> <inn>192644882</inn> <documentType /> <documentSeries /> <documentNumber /> <counteragentUid>e0a79552-bcf4-4ca2-bb5b-961bd2c0f9a2</counteragentUid> </payer> <freight> <name>Мебель</name> <weight>2.0</weight> <oversizedWeight>0.0</oversizedWeight> <volume>2.0</volume> <oversizedVolume>0.0</oversizedVolume> <places>1</places> <oversizedPlaces>0</oversizedPlaces> <length>0.0</length> <width>0.0</width> <height>0.0</height> </freight> <cargoPlaces> <number>3252235</number> <amount>1</amount> </cargoPlaces> <isAir>false</isAir> <air> <arrivalDate>2020-10-01</arrivalDate> <giveoutDate>2020-10-01</giveoutDate> <warehousingDate>2020-10-06</warehousingDate> <deliveryDate>2020-10-01</deliveryDate> <comment>комментарий</comment> <orderId>123-12312323</orderId> </air> <locks> <name>Долг</name> <type>by_payment</type> <setDate>2020-10-01 11:51:47</setDate> <endDate /> </locks> <webOrderItemsSum /> <withWebOrder>true</withWebOrder> <totalSum>7644.0</totalSum> <vat>1171.33</vat> <isPaid>false</isPaid> <isPreorder>false</isPreorder> <produceDate>2020-10-10</produceDate> <declineReason /> <orderDates> <arrivalToOspReceiver>2020-10-14</arrivalToOspReceiver> <arrivalToOspReceiverMax /> <arrivalToOspReceiverAccdoc /> <arrivalToOspSender /> <arrivalToReceiver /> <declineDate /> <derivalFromOspReceiver /> <derivalFromOspReceiverMax /> <derivalFromOspReceiverAccdoc /> <giveoutFromOspReceiver /> <giveoutFromOspReceiverMax /> <derivalFromOspSender>2020-10-13 00:00:00</derivalFromOspSender> <draftLastUpdate /> <finish /> <firstDocumentCreatedDate>2020-10-01</firstDocumentCreatedDate> <pickup>2020-10-10 00:00:00</pickup> <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> <cityID>200555</cityID> <docNumber>20-00015100302</docNumber> <price>1490.0</price> </sfrequest> <documents> <id>400275691</id> <uid /> <type>request</type> <createDate>2020-10-01 11:36:27</createDate> <state>accepted</state> <sender> <opf>ООО</opf> <opfUid>0xa8123a457e644fe7435605b8f632f9d3</opfUid> <name>Анкоррес Электро</name> <isPhysical>false</isPhysical> <inn>192644883</inn> <documentType /> <documentSeries /> <documentNumber /> <counteragentUid /> </sender> <receiver> <opf>ОАО</opf> <opfUid>0x8390b2048d37e0154b845fb22793e865</opfUid> <name>ДД-Мед</name> <isPhysical>false</isPhysical> <inn>7710647613</inn> <documentType /> <documentSeries /> <documentNumber /> <counteragentUid /> </receiver> <payer> <opf /> <opfUid></opfUid> <name>Анкоррес Электро</name> <isPhysical /> <inn>192644882</inn> <documentType /> <documentSeries /> <documentNumber /> <counteragentUid /> </payer> <produceDate>2020-10-10</produceDate> <forwarderId>00860733921</forwarderId> <comment>комментарий к отправке</comment> <fullDocumentId>K-400275691</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>7800000000000000000000000</code> </derival> <arrival> <name>Москва</name> <code>7700000000000000000000000</code> </arrival> <barcode /> <payment /> <totalSum /> <vat /> <serviceKind /> <organization /> </documents> <documents> <id>20-00015100302</id> <uid>0x81f400505683df3d11eb03c3460a5915</uid> <type>shipping</type> <createDate>2020-10-01 14:51:09</createDate> <state>in way</state> <sender> <opf /> <opfUid>0xa8123a457e644fe7435605b8f632f9d3</opfUid> <name>ООО "Анкоррес Электро"</name> <isPhysical>false</isPhysical> <inn>192644882</inn> <documentType /> <documentSeries /> <documentNumber /> <counteragentUid>e0a79552-bcf4-4ca2-bb5b-961bd2c0f9a2</counteragentUid> </sender> <receiver> <opf>ООО</opf> <opfUid>0x92ee03691f25a9fe4be9910cd87ca9ca</opfUid> <name>ООО "ДД МЕДИКА"</name> <isPhysical>false</isPhysical> <inn>7710647612</inn> <documentType /> <documentSeries /> <documentNumber /> <counteragentUid>b2763d61-e1b3-4c26-b46a-b3c95875a9c2</counteragentUid> </receiver> <payer> <opf /> <opfUid>0xa8123a457e644fe7435605b8f632f9d3</opfUid> <name>ООО "Анкоррес Электро"</name> <isPhysical>false</isPhysical> <inn>192644882</inn> <documentType /> <documentSeries /> <documentNumber /> <counteragentUid>e0a79552-bcf4-4ca2-bb5b-961bd2c0f9a2</counteragentUid> </payer> <produceDate /> <forwarderId /> <comment /> <fullDocumentId /> <freight> <name>Мебель</name> <weight>2</weight> <oversizedWeight>0</oversizedWeight> <volume>2</volume> <oversizedVolume>0</oversizedVolume> <maxLength>0</maxLength> <maxWidth>0</maxWidth> <maxHeight>0</maxHeight> </freight> <derival> <name>Санкт-Петербург</name> <code>7800000000000000000000000</code> </derival> <arrival> <name>Москва</name> <code>7700000000000000000000000</code> </arrival> <barcode /> <payment>false</payment> <totalSum>7644</totalSum> <vat>1171.33</vat> <serviceKind>Авто</serviceKind> <organization>0x9efb0013cea09f3311dcd80f7091a6d0</organization> <services> <name>Экспедирование до клиента</name> <serviceUid>0xa191584309b83a6a4b5c253d4d6ec797</serviceUid> <createdAt>2020-10-01 11:52:05</createdAt> <quantity>1</quantity> <sum>1490.0</sum> <totalSum>1490.0</totalSum> <vat>248.30</vat> <vatRate>20%</vatRate> <discountSum>0.0</discountSum> </services> <availableDocs>order</availableDocs> <availableDocs>bill</availableDocs> </documents> <orderDatesAdditional> <tracing> <title>Отбытие из ОСП</title> <date>2020-10-01</date> <cityUID>0x834f00112fdd658311da4c6326ef0e0e</cityUID> <cityName>Волгоград</cityName> <status>inway</status> </tracing> <tracing> <title>Отбытие из ОСП</title> <date>2019-10-01</date> <cityUID>0x834f00112fdd658311da4c6326ef0e19</cityUID> <cityName>Уфа</cityName> <status>inway</status> </tracing> </orderDatesAdditional> <detailedStatus /> <detailedStatusRus /> <note /> <documentsReturnDate /> <priceComment></priceComment> <customerUid>00000000-0000-0000-0000-000000000000</customerUid> <acceptanceActs> <acceptanceActNumber>5775757575</acceptanceActNumber> <acceptanceActDate>2020-10-01</acceptanceActDate> <acceptanceActType></acceptanceActType> </acceptanceActs> <acceptanceActs> <acceptanceActNumber>5775757575/111</acceptanceActNumber> <acceptanceActDate>2020-10-02</acceptanceActDate> <acceptanceActType>Исправленный</acceptanceActType> </acceptanceActs> <shipmentLabelCargoPlace>Артикул1223657</shipmentLabelCargoPlace> </orders> <deleted /> </response>
Описание параметров
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" или "processing"), то значение параметра - null |
returnState | boolean | Да | Признак возвратного груза |
returnReason | string | Да | Причина возврата груза |
returnDate | string | Да | Дата и время установки признака возвратного груза |
progressPercent | integer | Да | Степень выполнения заказа (в процентах). Значение параметра может быть использовано для визуализации хода выполнения заказа |
derival | DerivalArrival | Частично | Информация о месте отправки |
arrival | DerivalArrival | Частично | Информация о месте получения |
sender | Member | Нет | Информация об отправителе |
receiver | Member | Нет | Информация о получателе |
payer | Member | Нет | Информация о плательщике |
freight | Freight | Нет | Информация о грузе |
cargoPlaces | array of CargoPlaces | Нет | Информация о грузовых местах |
cargoPlaces.number | string | Нет | Номер грузового места |
cargoPlaces.amount | integer | Нет | Количество грузовых мест с идентичным номером |
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 | Нет | Массив блокировок по заказу |
webOrderItemsSum | float | Нет | Сумма наложенного платежа Данные доступны только в том случае, если у текущей учётной записи есть полный доступ к контрагенту (см. метод "Список контрагентов", описание параметра ответа "info.accessLevel") |
withWebOrder | boolean | Нет | Признак наложенного платежа |
totalSum | string | Да | Общая сумма заказа |
vat | string | Нет | НДС |
isPaid | boolean | Да | Статус оплаты заказа |
isPreorder | boolean | Нет | Флаг, обозначающий что заказ является предзаказом |
produceDate | string | Да | Дата выполнения заказа Данные недоступны при заказе услуги "Мультиотправка" |
declineReason | string | Да | Причина отклонения Данные доступны, только если заказ был отклонён |
orderDates | object | Да | Расчетный график движения груза |
orderDates.arrivalToOspReceiver | string | Да | Дата прибытия груза на терминал-получатель |
orderDates.arrivalToOspReceiverMax | string | Да | Максимальная дата прибытия груза на терминал-получатель (в случае, если возможно увеличение срока прибытия) |
orderDates.arrivalToOspReceiverAccdoc | string | Да | Дата прибытия сопроводительных документов на терминал-получатель |
orderDates.arrivalToOspSender | string | Да | Дата прибытия груза на терминал-отправитель |
orderDates.arrivalToReceiver | string | Да | Дата доставки груза до адреса:
При отсутствии расчётной даты доставки, в ответе метода содержится расчётный срок доставки см. описание параметра ответа "orders.orderTimeInDays.delivery" |
orderDates.declineDate | string | Да | Дата отклонения В отдельных случаях данные могут отсутствовать |
orderDates.derivalFromOspReceiver | string | Да | Дата отправки с терминала-получателя |
orderDates.derivalFromOspReceiverMax | string | Да | Максимальная дата отправки с терминала-получателя (в случае, если возможно увеличение срока отправки) |
orderDates.derivalFromOspReceiverAccdoc | 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 | Да | Срок доставки груза. Отсчитывается от даты, пришедшей в параметре "orderDates.derivalFromOspReceiver". Информация присутствует в ответе, если заказана доставка до адреса и отсутствует дата доставки груза до адреса (см. описание параметра ответа "orders.orderDates.arrivalToReceiver") |
orderTimeInDays.deliveryAccdoc | integer | Да | Срок доставки сопроводительных документов. Отсчитывается от даты, пришедшей в параметре "orderDates.derivalFromOspReceiverAccdoc" |
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 часов (значение параметра "response.state" - "declined" или же значение параметра "response.state" изменилось на "finished" более 24 часов назад) |
detailedStatus | string | Да | Дополнительный статус заказа на английском языке. Возможные значения (порядок соответствует порядку возможных значений параметра "detailedStatusRus"):
|
detailedStatusRus | string | Да | Дополнительный статус заказа на русском языке. Возможные значения (порядок соответствует порядку возможных значений параметра "detailedStatus"):
|
note | string | Нет | Комментарий к заказу. Пользователь может оставить комментарий к заказу в личном кабинете на сайте компании "Деловых Линии" |
documentsReturnDate | string | Нет | Ориентировочная дата возврата сопроводительных документов. |
priceComment | string | Да | Комментарий, свидетельствующий о том, что информация о стоимости заказа недоступна текущему пользователю |
customerUid | string | Нет | UID заказчика по заявке Данные присутствуют в ответе, только если у пользователя есть полный доступ к контрагенту (см. метод "Список контрагентов", описание параметра ответа "info.accessLevel") |
acceptanceActs | array of acceptanceActs | Да | Данные счёта-фактуры |
acceptanceActs.acceptanceActNumber | string | Да | Номер. Формат: "ГГГГ-ММ-ДД" |
acceptanceActs.acceptanceActDate | string | Да | Дата |
acceptanceActs.acceptanceActType | string | Да | Тип. Возможные значения:
В случае обычного счёта-фактуры параметр приходит пустым |
shipmentLabelCargoPlace | string | Нет | Артикул грузового места |
DerivalArrival
DerivalArrival | ||||
---|---|---|---|---|
Параметр | Тип | Данные доступны неавторизованным пользователям | Описание | |
response.orders.derival | response.orders.arrival | |||
city | string | Нет | Да | Город отправки/доставки груза |
cityId | integer | Да | Да | ID города отправления/прибытия |
cityCode | string | Да | Да | Код КЛАДР города, см. "Поиск населённых пунктов" |
address | string | Нет | Нет | Адрес отправки/доставки груза |
addressCode | string | Нет | Нет | Код КЛАДР улицы, см. "Поиск улиц" |
terminalName | string | Нет | Нет | Наименование терминала хранения |
terminalAddress | string | Нет | Да | Адрес терминала хранения |
terminalId | integer | Да | Да | ID терминала-отправителя/получателя из "Справочника терминалов" |
terminalCity | string | - | Да | Город терминала хранения (1) |
terminalCoordinates | array of floats | - | Да | Долгота и широта терминала хранения (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 | - | Да | График работы терминала хранения в субботу |
specialWorktable | object | - | Да | График работы терминала хранения в праздничные дни (1) |
specialWorktable.receive | array of strings | - | Да | График работы терминала хранения на прием груза (в праздничные дни) |
specialWorktable.giveout | array of strings | - | Да | График работы терминала хранения на выдачу груза (в праздничные дни) |
Примечания:
|
Member
Member | ||
---|---|---|
Параметр | Тип | Описание |
opf | string | Организационно-правовая форма ОПФ (1) Параметр используется только для объектов "response.orders.documents.sender", "response.orders.documents.receiver", "response.orders.documents.payer" |
opf | object | ОПФ Параметр используется только для объектов "response.orders.sender", "response.orders.receiver", "response.orders.payer" |
opf.name | string | Сокращённое наименование ОПФ |
opf.fullName | string | Полное наименование ОПФ |
opf.countryCode | integer | Код страны |
opfUid | string | UID ОПФ, см. метод "Поиск ОПФ" (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 контрагента (2) |
contacts | string | ФИО контактного лица отправителя (2) |
phones | string | Телефон контрагента Параметр используется только для объекта "response.orders.sender" |
anonym | boolean | Признак контрагента с минимальным набором данных - "анонимного" получателя (3) |
anonymEmail | string | Email "анонимного" получателя (3) |
anonymPhone | string | Телефон "анонимного" получателя (3) |
Примечания:
|
Freight
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 | Высота груза, м |
Примечания:
|
Locks
Locks | ||
---|---|---|
Параметр | Тип | Описание |
name | string | Наименование блокировки |
type | string | Тип блокировки |
setDate | string | Дата установки блокировки |
endDate | string | Дата снятия блокировки |
Documents
Documents | |||
---|---|---|---|
Параметр | Тип | Данные доступны неавторизованным пользователям | Описание |
id | integer | Да | Номер документа |
uid | string | Да | UID накладной (1) |
type | string | Да | Тип документа. Возможные значения:
|
createDate | string | Да | Дата создания документа |
state | string | Да | Статус документа У заявки на доставку от адреса отправителя/до адреса получателя/на междугороднюю перевозку выделенной еврофурой (значение параметра "response.orders.documents.type" - "request"/"request_sf"/"request_ftl") могут быть следующие статусы:
Для документа типа "Накладная" (значение параметра "response.orders.documents.type" - "shipping") статус присутствует в ответе, но не используется (всегда имеет значение "in_way") |
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 | string | Да | Общая сумма по накладной (1) |
vat | string | Нет | НДС (1) |
serviceKind | string | Да | Тип перевозки (1) |
organization | string | Нет | ID организации (1) |
services | array of Services | Частично | Перечень услуг по накладной (1) |
accompanyingDocuments | array of AcDocs | Нет | Перечень сопроводительных документов (1) |
availableDocs | array of strings | Нет | Перечень документов, по которым можно получить печатные формы (1) |
Примечания:
|
Services
Services | ||
---|---|---|
Параметр | Тип | Описание |
name | string | Наименование услуги |
serviceUid | string | UID услуги |
createdAt | string | Дата создания |
quantity | integer | Количество |
sum | string | Сумма |
totalSum | string | Сумма итого |
vat | string | НДС |
vatRate | string | Ставка НДС, если НДС не применяется, то выводится значение "БЕЗ НДС" |
discountSum | string | Сумма скидки |
AcDocs
AcDocs | ||
---|---|---|
Параметр | Тип | Описание |
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 | Неизвестный статус заказа | Детальное описание ошибки содержит номера заказов с неизвестным статусом |