Orders list
General information
The service allows tracking orders using Delovye Linii order number or waybill number or number of order for shipping, as well as internal online store order number or document barcode. Authorized users may use the method to get the list of orders that have been created in the personal account as well as information about the actual statuses of orders, orders for shipping and waybills
The request parameter request.sessionID is used to differentiate whether to provide short or detailed information. If а request contains the parameter, then detailed information will be provided, if not - short. Thus, only authorized users have access to detailed orders information.
Orders list
Method request
Request structure
Method address: 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 }
Method address: 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>
Description of parameters
Request
Request | |||
---|---|---|---|
Parameter | Required | Type | Description |
appKey | Yes | string | Application key. To get the key, register |
sessionID | No* | string | Session ID. To get the session ID, use "User authorization" service. *If sessionID parameter is passed in a request, then detailed information will be provided, if not - short |
docIds | No* | array of strings | Number of order, waybill or order for shipping from address/delivery to address. More than one parameter can be passed (5 parameters maximum). *The parameter is used to search for orders. If sessionID parameter is not passed in a request, then one of the following parameters must be passed: docIds, orderNumber or barcode Only one of the following parameters can be passed in a request: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace |
orderNumber | No* | string | Online store order number (internal order number). *The parameter is used to search for orders. If sessionID parameter is not passed in the request, then one of the following parameters must be passed: docIds, orderNumber or barcode Only one of the following parameters can be passed in a request: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace |
orderDate | No | string | Online store order date. Format: YYYY-MM-DD |
barcode | No* | string | Barcode read by a scanner. The following barcodes can be used to search for the order:
*The parameter is used to search for orders. If sessionID parameter is not passed in a request, then one of the following parameters must be passed: docIds, orderNumber or barcode Only one of the following parameters can be passed in a request: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace Pre-orderIf a client wants to bring the cargo to the company terminal, they may place an order online, print the paper and bring it to the terminal. Thus they will be able to save time since the clients who placed a pre-order are served out of turn. For more information see Delovye Linii company website. |
cargoPlaces | No* | array of strings | Array of numbers of cargo places. *The parameter is used to search for orders by authorized users (can only be passed if sessionID parameter is passed in a request) Only one of the following parameters can be passed in a request: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace The search is performed only on the first value passed in the array |
shipmentLabelCargoPlace | No* | string | Cargo place code number. *The parameter is used to search for orders by authorized users (can only be passed if sessionID parameter is passed in a request). To search by cargo place code number it is necessary to pass the information on cargo places (see "Passing the packages code numbers" method). The users with limited access can search orders in which they act as requesters, the users with the full access can search all orders regardless their role (for more information on access level see "Available counterparties" method, response parameter "info.accessLevel"). If the delivery from the sender's address is ordered and the cargo has not yet been accepted at the company terminal, then the information about the order is available only to the user who placed the order. Only one of the following parameters can be passed in a request: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace |
dateStart | No | string | Period start date and time (the parameter is used to filter search results by order creation period). Format: YYYY-MM-DD HH:MM:SS. The parameter is ignored if the request does not contain sessionID parameter or contains one of the following parameters: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace |
dateEnd | No | string | Period end date and time (the parameter is used to filter search results by the period of order creation, the parameter is ignored if a request does not contain dateStart). Format: YYYY-MM-DD HH:MM:SS. The parameter is ignored if a request does not contain sessionID parameter or contains one of the following parameters: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace |
states | No | array of strings | Array of the requested order statutes. For the complete list of statuses, see "Directory of order statuses". The parameter is ignored if a request does not contain sessionID parameter or contains one of the following parameters: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace |
page | No | integer | Number of the requested page |
lastUpdate | No | string | The parameter is used to filter orders updated after the indicated date. Format: YYYY-MM-DD HH:MM:SS. The parameter is ignored if а request does not contain sessionID parameter or contains one of the following parameters: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace. If the "states" parameter with the "inway" value is passed in the request, then the response contains all the orders with the "inway" status. Thus the "lastUpdate" parameter is ignored in this case. For other statuses the logic is different - the response contains only orders with the indicated status that were updated after the date passed in the "lastUpdate" parameter |
orderBy | No | string | Orders sorting. Possible values:
The parameter is ignored if а request does not contain sessionID parameter or contains one of the following parameters: docIds, orderNumber, barcode, сargoPlaces, shipmentLabelCargoPlace |
orderDatesAdditional | No | boolean | Flag indicating that information on intermediate route points is required |
Method respose
Response structure
{ "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>
Description of parameters
Response
Response | |||
---|---|---|---|
Parameter | Type | Data available to unathorised users | Description |
metadata | object | Yes | System information |
metadata.status | integer | Yes | Emulated status http-code. If successful, code 200 is returned |
metadata.currentPage | integer | Yes | Number of the current page of the response |
metadata.nextPage | integer | Yes | Number of the next page of the response |
metadata.prevPage | integer | Yes | Number of the previous page of the response. If the current page number is 1, then the parameter value is null |
metadata.totalPages | integer | Yes | Total amount of pages |
metadata.generatedAt | string | Yes | Server response date and time. Format: YYYY-MM-DD HH:MM:SS |
orders | array of Orders | Yes | Array of orders found |
deleted | array of strings | Yes | Array of deleted orders (the data is available if request.lastUpdate parameter is passed in a request) |
Orders
Orders | |||
---|---|---|---|
Parameter | Type | Data available to unauthorized users | Description |
orderNumber | string | Yes | Online store order number (internal order number) |
orderDate | string | Yes | Online store order date |
orderID | string | Yes | Order number |
orderedAt | string | Yes | Date of order creation |
state | string | Yes | Order status in English, see "Directory of order statuses" |
stateName | string | Yes | Order status in Russian, see "Directory of order statuses" |
stateDate | string | Yes | Date when the current status was set. Format: YYYY-MM-DD. If the order status (value of the response parameter "orders.state") is "draft" or "processing", then the parameter value is null |
returnState | boolean | Yes | Returned cargo indicator |
returnReason | string | Yes | Reason for cargo return. Possible values:
|
returnDate | string | Yes | Date and time when the returned cargo indicator was set |
progressPercent | integer | Yes | Order completion (in percent). The parameter value can be used to visualize the progress of the order. |
derival | DerivalArrival | Partially | Departure details |
arrival | DerivalArrival | Partially | Arrival details |
sender | Member | No | Sender details |
receiver | Member | No | Receiver details |
payer | Member | No | Payer details |
freight | Freight | No | Cargo details |
cargoPlaces | array of CargoPlaces | No | Cargo places details |
cargoPlaces.number | string | No | Cargo place number |
cargoPlaces.amount | integer | No | Quantity of cargo places with the same number |
isAir | boolean | Yes | Air freight indicator |
air | object | Yes | Air freight details If isAir parameter value is false, then the object parameters will not be passed in the response |
air.arrivalDate | string | Yes | Cargo arrival date for air freight |
air.giveoutDate | string | Yes | Cargo release date for air freight |
air.warehousingDate | string | Yes | Paid storage start date for air freight |
air.deliveryDate | string | Yes | Estimated cargo arrival date for air freight |
air.comment | string | No | Additional information |
air.orderId | string | Yes | Airway bill number |
locks | array of Locks | No | Array of lockouts |
webOrderItemsSum | float | No | Cash on delivery amount The information is present in the response only if there is full access to the counterparty in the current account (see "Available counterparties" method, response parameter "info.accessLevel") |
withWebOrder | boolean | No | Cash on delivery indicator |
totalSum | string | Yes | Total amount |
vat | string | No | VAT |
isPaid | boolean | Yes | Order payment status |
isPreorder | boolean | No | Pre-order indicator |
produceDate | string | Yes | Order completion date The data is not available for Multishipping |
declineReason | string | Yes | Rejection reason The data is available only if the order has been declined |
orderDates | object | Yes | Estimated cargo transportation schedule |
orderDates.arrivalToOspReceiver | string | Yes | Date of cargo arrival at the terminal of arrival |
orderDates.arrivalToOspReceiverMax | string | Yes | The latest possible date of cargo arrival at the terminal of arrival (if cargo arrival can be delayed) |
orderDates.arrivalToOspReceiverAccdoc | string | Yes | Date of shipping documents arrival at the terminal of arrival |
orderDates.arrivalToOspSender | string | Yes | Date of cargo arrival at the terminal of departure |
orderDates.arrivalToReceiver | string | Yes | Date of cargo delivery to the receiver's address:
If the information on the estimated date is not available, then there will be information on estimated delivery time in the response (see "orders.orderTimeInDays.delivery" response parameter) |
orderDates.declineDate | string | Yes | Rejection date In some cases data may not be available |
orderDates.derivalFromOspReceiver | string | Yes | Date of cargo departure from the terminal of arrival |
orderDates.derivalFromOspReceiverMax | string | Yes | The latest possible date of cargo departure from the terminal of arrival (if cargo departure can be delayed) |
orderDates.derivalFromOspReceiverAccdoc | string | Yes | Date of shipping documents departure from the terminal of arrival |
orderDates.giveoutFromOspReceiver | string | Yes | Date when cargo is ready to be handed out at the terminal of arrival |
orderDates.giveoutFromOspReceiverMax | string | Yes | The latest possible date when cargo is ready to be handed out at the terminal of arrival (if the date can be delayed) |
orderDates.derivalFromOspSender | string | Yes | Date of cargo departure from the terminal of departure |
orderDates.draftLastUpdate | string | Yes | Date of draft last update |
orderDates.finish | string | Yes | Order completion date |
orderDates.firstDocumentCreatedDate | string | Yes | Date when the first document was created |
orderDates.pickup | string | Yes | Date of cargo pickup from the sender's address |
orderDates.processingDate | string | Yes | Order processing start date |
orderDates.warehousing | string | Yes | Paid storage start date |
orderTimeInDays | object | Yes | Estimated delivery time (in days) The data is available only if is_air parameter value is false. Otherwise, values of all the object parameters is null |
orderTimeInDays.delivery | integer | Yes | Estimated time of cargo delivery to the address. Is calculated from the date indicated in "orderDates.derivalFromOspReceiver" parameter. The information is present in the response if the delivery to the address has been ordered and there is no information on date of cargo delivery to the receivers address (see "orders.orderDates.arrivalToReceiver" response parameter) |
orderTimeInDays.deliveryAccdoc | integer | Yes | Estimated time of shipping documents delivery to the address. Is calculated from the date indicated in "orderDates.derivalFromOspReceiverAccdoc" parameter |
orderedDeliveryFromAddress | boolean | Yes | Flag indicating that shipping from the sender's address is ordered |
availableDeliveryFromAddress | boolean | No | Flag indicating that shipping from the sender's address is available |
orderedDeliveryToAddress | boolean | Yes | Flag indicating that delivery to the receiver's address is ordered |
availableDeliveryToAddress | boolean | No | Flag indicating that delivery to the receiver's address is available |
isFavorite | boolean | No | Flag indicating that order is added to favorites |
isContainer | boolean | Yes | Flag indicating container shipping |
sfrequest | object | Yes | Details of order for delivery to the receiver's address |
sfrequest.cityID | integer | Yes | City ID, see "Places search" method |
sfrequest.docNumber | string | Yes | Waybill number |
sfrequest.price | string | Yes | Shipping cost |
documents | Documents | Partially | Array of order documents |
orderDatesAdditional | OrderDatesAdditional | Yes | Information on the intermediate route points The parameter is missing in the response if the order is declined or has been finished more that 24 hours ago (that is when "response.state" parameter value is "declined" or has changed to "finished" more that 24 ago) |
detailedStatus | string | Yes | Detailed order status in English. Possible values (the statuses order corresponds to the order of the possible values of "detailedStatusRus" parameter):
|
detailedStatusRus | string | Yes | Detailed order status in Russian. Possible values (the statuses order corresponds to the order of the possible values of "detailedStatus" parameter):
|
note | string | No | Note to the order. The user can leave a note to ther order in his personal account on "Delovye Linii" company website |
documentsReturnDate | string | No | Estimated date of shipping documents return |
priceComment | string | Yes | A comment indicating that information about the order price is not available to the current user |
customerUID | string | No | UID of the requester on the order The data is present in the response only if the user has full access to the counterparty (see "Available counterparties" method, response parameter "info.accessLevel") |
acceptanceActs | array of acceptanceActs | Yes | Invoice data |
acceptanceActs.acceptanceActNumber | string | Yes | Number |
acceptanceActs.acceptanceActDate | string | Yes | Date Format: YYYY-MM-DD. |
acceptanceActs.acceptanceActType | string | Yes | Type. Possible values:
If the parameter is empty, then it is a regular invoice |
shipmentLabelCargoPlace | string | No | Сargo place code number |
DerivalArrival
DerivalArrival | ||||
---|---|---|---|---|
Parameter | Type | Data available to unathorised users | Description | |
response.orders.derival | response.orders.arrival | |||
city | string | No | Yes | City of cargo departure/arrival |
cityId | integer | Yes | Yes | ID of the city of departure/arrival |
cityCode | string | Yes | Yes | City CLADR code (CLADR - Classifier of Addresses of the Russian Federation), see "Places search" |
address | string | No | No | Address of the city of departure/arrival |
addressCode | string | No | No | Street CLADR code, see "Streets search" |
terminalName | string | No | No | Terminal name |
terminalAddress | string | No | Yes | Terminal address |
terminalId | integer | Yes | Yes | Terminal ID, see "Terminals directory" |
terminalCity | string | - | Yes | City of storage terminal (1) |
terminalCoordinates | array of floats | - | Yes | Longitude and latitude of the storage terminal (1) |
terminalEmail | string | - | Yes | Email of the storage terminal (1) |
terminalPhones | string | - | Yes | Storage terminal phone number (1) |
callCenterPhones | string | - | Yes | Call center phone number (1) |
terminalWorktables | object | - | Yes | Storage terminal workhours (1) |
terminalWorktables.sun | string | Sunday workhours | ||
terminalWorktables.mon | string | Monday workhours | ||
terminalWorktables.tue | string | Tuesday workhours | ||
terminalWorktables.wed | string | Wednesday workhours | ||
terminalWorktables.thu | string | Thursday workhours | ||
terminalWorktables.fri | string | Friday workhours | ||
terminalWorktables.sat | string | Saturday workhours | ||
specialWorktable | object | Storage terminal workhours on holydays (1) | ||
specialWorktable.receive | array of strings | Storage terminal workhours for accepting the cargo (on holydays) | ||
specialWorktable.giveout | array of strings | Storage terminal workhours for giving out the cargo (on holydays) | ||
Notes:
|
Member
Member | ||
---|---|---|
Parameter | Type | Description |
opf | object | Organization legal form The parameter is used only for "response.orders.sender", "response.orders.receiver" and "response.orders.payer" objects |
opf.name | string | Short legal form name |
opf.fullName | string | Full legal form name |
opf.countryCode | integer | Country code |
opf | string | Organization legal form (1) The parameter is used only for "response.orders.documents.sender", "response.orders.documents.receiver" and "response.orders.documents.payer" objects |
opfUid | string | UID of legal form of organization form, see "Search of forms of organization" (1) |
name | string | Counterparty name |
address | string | Counterparty address The parameter is used only for response.orders.sender, response.orders.receiver objects |
isPhysical | boolean | Flag indicating individual (1) |
inn | string | TIN - taxpayer identification number (1) |
documentType | string | Personal ID for the individuals (1) Possible values:
|
documentSeries | string | Individuals personal ID series (1) |
documentNumber | string | Individuals personal ID number (1) |
сounteragentUid | string | Counterparty UID For response.orders.documents.sender, response.orders.documents.receiver, response.orders.documents.payer objects: the data is available only for waybills (response.orders.documents.type parameter value is shipping) |
contacts | string | Sender's contact person name (2) |
phones | string | Counterparty phone number (2) |
anonym | boolean | Indicator of an "anonymous" receiver (3) |
anonymEmail | string | "Anonymous" receiver email (3) |
anonymPhone | string | "Anonymous" receiver phone number (3) |
Notes:
|
Freight
Freight | ||||
---|---|---|---|---|
Parameter | Type | Description | ||
response.orders.freight | response.orders.documents.freight | response.orders.freight | response.orders.documents.freight | |
name | name | string | string | Cargo name |
weight | weight | string | float | Cargo weight, kg |
oversizedWeight | oversizedWeight | string | float | Weight of oversized cargo places, kg |
volume | volume | string | float | Cargo volume, m3 |
oversizedVolume | oversizedVolume | string | float | Volume of oversized cargo places, m3 |
places | - | integer | - | Qantity of cargo places |
oversizedPlaces | - | integer | - | Qantity of oversized cargo places |
length | maxLength | string | float | Cargo length, m |
width | maxWidth | string | float | Cargo width, m |
height | maxHeight | string | float | Cargo height, m |
Notes:
|
Locks
Locks | ||
---|---|---|
Parameter | Type | Description |
name | string | Lockout name |
type | string | Lockout name |
setDate | string | Lockout start date |
endDate | string | Lockout end date |
Documents
Documents | |||
---|---|---|---|
Parameter | Type | Data available to unathorised users | Description |
id | integer | Yes | Document number |
uid | string | Yes | Waybill UID (1) |
type | string | Yes | Document type Possible values:
|
createDate | string | Yes | Date of document creation |
state | string | Yes | Document status Order for shipping from the sender's address/delivery to the receiver's address/intercity transportation by dedicated truck (response.orders.documents.type parameter value is request/request_sf/request_ftl) statuses:
Status for Waybill (response.orders.documents.type parameter value is shipping) is present in the response, but is not currently used (the value is always "in_way") |
sender | Member | No | Sender details (2) |
receiver | Member | No | Receiver details (2) |
payer | Member | No | Payer details |
produceDate | string | Yes | Order completion date (3) |
forwarderId | string | No | Forwarding agent order number (3) |
comment | string | No | Additional information on the documents (3) |
fullDocumentId | string | Yes | Full document number (3) |
freight | Freight | No | Cargo details (4) |
derival | object | Yes | Information about the place of departure (4) |
derival.name | string | Yes | City (4) |
derival.code | string | Yes | City CLADR code, see "Places search" (4) |
arrival | object | Yes | Information about the place of arrival (4) |
arrival.name | string | Yes | City (4) |
arrival.code | string | Yes | City CLADR code, see "Places search" (4) |
barcode | string | No | |
payment | boolean | Yes | Payment status (1) |
totalSum | string | Yes | Total amount on the waybill (1) |
vat | string | No | VAT (1) |
serviceKind | string | Yes | Transportation type (1) |
organization | string | No | Organization ID (1) |
services | array of Services | Partially | List of services as per the waybill (1) |
accompanyingDocuments | array of AcDocs | No | List of the shipping documents (1) |
availableDocs | array of strings | No | List of the documents for which printable versions are available (1) |
Notes:
|
Services
Services | ||
---|---|---|
Parameter | Type | Description |
name | string | Service name |
serviceUid | string | Service UID |
createdAt | string | Creation date |
quantity | integer | Quantity |
sum | string | Amount |
totalSum | string | Total amount |
vat | string | VAT |
vatRate | string | VAT rate, if VAT is not applied, then the parameter value is "БЕЗ НДС" (VAT exempt) |
discountSum | string | Discount |
AcDocs
AcDocs | ||
---|---|---|
Parameter | Type | Description |
documentDate | string | Shipping document creation date |
documentNumber | string | Shipping document number |
documentKind | string | Comment (document type) |
OrderDatesAdditional
OrderDatesAdditional | ||
---|---|---|
Parameter | Type | Description |
tracing | array of Tracing | List of intermediate route points. 10 elements in the array maximum. If more than 10 points are found, data of the 10 latest points is passed in the response |
tracing.title | string | The event the date of which is passed in the "tracing.date" parameter. The value is always "Отбытие из ОСП" (leaving the terminal) |
tracing.date | string | Date when the cargo passes the route point. Date format: YYYY-MM-DD |
tracing.cityUID | string | UID of the City (intermediate route point) |
tracing.cityName | string | City (intermediate route point) |
tracing.status | string | The status of the order when cargo passes the route point. The value is always "inway" (see "Directory of order statuses") |
Error handling
Except for common API errors the method response may contain the following errors:
Error number | http-code | Error title | Error description | ||
---|---|---|---|---|---|
Title | Translation | Description | Translation | ||
718001 | 400 | Найдено более одного заказа | More than one order found | Воспользуйтесь расширенным поиском | Use advanced search |
717001 | 400 | Заказ не найден | Order not found | Заказ [номер заказа] не найден | Order [order number] not found |
717002 | 400 | Неизвестный статус заказа | Unknown order status | Детальное описание ошибки содержит номера заказов с неизвестным статусом | Detailed error description contains the list of numbers of orders with unknown status |