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

API
Главная / API - Order tracker

Order tracker

Обновлено 25.07.2019
133 кб

General information

This service allows you to get information about the order by its number or number of the waybill or claim.

Searching the order by number of the order, waybill or claim

Method request

Request example

Method address: https://api.dellin.ru/v2/public/tracker.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "docid":"63763576",
   "barcode":"4150846060806D53800000017",
   "orderNumber":"1234567",
   "orderDate":"2017-01-15"
}

Method address: https://api.dellin.ru/v2/public/tracker.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <docid>63763576</docid>
   <barcode>4150846060806D53800000017</barcode>
   <orderNumber>1234567</orderNumber>
   <orderDate>2017-01-15</orderDate>
</request>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstring

Application key. To get the key, register

docidYes*string

Number of the order, waybill or claim

*Parameter is required only if the "barcode" and "orderNumber" parameters are not passed. Request can include only one of the next parameters: "docid", "barcode", "orderNumber"

barcodeYes*string

Barcode of the document read by the barcode scanner.

The field length is 25 characters. The first 3 characters determine the type of document:

128 - invoice
415 - order for shipping (pre-order only)

*Parameter is required only if the "docid" and "orderNumber" parameters are not passed. Request can include only one of the next parameters: "docid", "barcode", "orderNumber"

orderNumberYes*string

Online store order number (internal order number).

*Parameter is required only if the "docid" and "barcode" parameters are not passed. Request can include only one of the next parameters: "docid", "barcode", "orderNumber"

orderDateNostring

Online store order date.

Format: "YYYY-MM-DD"

Method response

Example below contains a complete list of parameters, regardless of the order status. The last column of the table with description of parameters (below) contains infrormation about the statuses of the order for which corresponding parameters are actually displayed.

Response example

{  
   "orderNumber":"1234567",
   "orderDate":"2017-01-15",
   "order_id":123456,
   "ordered_at":"2017-01-16 11:20:05",
   "is_container":true,
   "state":"processing",
   "state_name":"В обработке",
   "derival_city":"Омск",
   "arrival_city":"Самара",
   "decline_reason":"Опасный груз",
   "sf_request_ordered":false,
   "sfrequest":{  
      "price":"500",
      "cityID":234,
      "docNumber":"16-123456789"
   },
   "derival_city_id":8,
   "derival_terminal_id":53,
   "arrival_contact_id":15,
   "arrival_city_id":21,
   "arrival_cc_phones":"8-800-100-8000",
   "arrival_terminal_name":"Санкт-Петербург Офис",
   "arrival_terminal_city":"Санкт-Петербург",
   "arrival_terminal_address":"Внуковская, д.2",
   "arrival_terminal_phones":"7 (812) 448-88-88",
   "arrival_terminal_email":"pismo@dellin.ru",
   "arrival_terminal_coordinates":["30.311464","59.805924"],
   "worktables":{  
      "mon":"9:00-18:00",
      "tue":"9:00-18:00",
      "wed":"9:00-18:00",
      "thu":"9:00-18:00",
      "fri":"9:00-18:00",
      "sat":"9:00-15:00",
      "sun":"-"
   },
   "air_order_id":123456,
   "is_air":false,
   "comment":"комментарий",
   "blocked_by_payment":false,
   "blocked_by_blacklist":false,
   "order_dates":{  
      "finish":"2017-03-30",
      "arrival_to_receiver":"2017-03-30",
      "arrival_to_osp_sender":"2017-03-30",
      "arrival_to_osp_receiver_accdoc":"2017-03-30",
      "first_document_created_date":"2017-03-30",
      "draft_last_update":"2017-03-30",
      "derrival_from_osp_sender":"2017-03-29",
      "derrival_from_osp_receiver_accdoc":"2017-03-30",
      "arrival_to_osp_receiver":"2017-03-30",
      "arrival_to_osp_receiver_max":"2017-03-30",
      "giveout_from_osp_receiver":"2017-03-30 00:00:00",
      "giveout_from_osp_receiver_max":"2017-03-30 00:00:00",
      "processing_date":"2017-03-25",
      "derrival_from_osp_receiver":"2017-03-30",
      "derrival_from_osp_receiver_max":"2017-03-30",
      "warehousing":"2017-03-30",
      "decline_date":"2017-03-30",
      "pickup":"2017-03-28"
   },
   "order_time_in_days":{  
      "delivery":0,
      "delivery_accdoc":null
   },
   "documents":[
      {  
         "create_date":"2018-12-12 17:36:58",
         "document_id":"15-01905000217",
         "document_type":"shipping",
         "document_uid":"0x9bcf2e07c8ff70e84bd7e62b335779c3",
         "payer":{  
            "access":false,
            "is_physical":true
         },
         "payment_state":"paid",
         "services":[  
            {  
               "name":"Перевозка автотранспортная"
            },
            {  
               "name":"Въезд на терминал-получатель"
            }
         ],
         "total_sum":3060.0
      }
   ]
}
<response>
   <orderNumber>1234567</orderNumber>
   <orderDate>2017-01-15</orderDate>
   <order_id>123456</order_id>
   <ordered_at>2017-01-16 11:20:05</ordered_at>
   <is_container>true</is_container>
   <state>processing</state>
   <state_name>В обработке</state_name>
   <derival_city>Омск</derival_city>
   <arrival_city>Самара</arrival_city>
   <decline_reason>Опасный груз</decline_reason>
   <sf_request_ordered>false</sf_request_ordered>
   <sfrequest>
      <price>500</price>
      <cityID>234</cityID>
      <docNumber>16-123456789</docNumber>
   </sfrequest>
   <derival_city_id>8</derival_city_id>
   <derival_terminal_id>53</derival_terminal_id>
   <arrival_contact_id>15</arrival_contact_id>
   <arrival_city_id>21</arrival_city_id>
   <arrival_cc_phones>8-800-100-8000</arrival_cc_phones>
   <arrival_terminal_name>Санкт-Петербург Офис</arrival_terminal_name>
   <arrival_terminal_city>Санкт-Петербург</arrival_terminal_city>
   <arrival_terminal_address>Внуковская, д.2</arrival_terminal_address>
   <arrival_terminal_phones>7 (812) 448-88-88</arrival_terminal_phones>
   <arrival_terminal_email>pismo@dellin.ru</arrival_terminal_email>
   <arrival_terminal_coordinates>30.311464</arrival_terminal_coordinates>
   <arrival_terminal_coordinates>59.805924</arrival_terminal_coordinates>
   <worktables>
      <mon>9:00-18:00</mon>
      <tue>9:00-18:00</tue>
      <wed>9:00-18:00</wed>
      <thu>9:00-18:00</thu>
      <fri>9:00-18:00</fri>
      <sat>9:00-15:00</sat>
      <sun>-</sun>
   </worktables>
   <air_order_id>123456</air_order_id>
   <is_air>false</is_air>
   <comment>комментарий</comment>
   <blocked_by_payment>false</blocked_by_payment>
   <blocked_by_blacklist>false</blocked_by_blacklist>
   <order_dates>
      <finish>2017-03-30</finish>
      <arrival_to_receiver>2017-03-30</arrival_to_receiver>
      <arrival_to_osp_sender>2017-03-30</arrival_to_osp_sender>
      <arrival_to_osp_receiver_accdoc>2017-03-30</arrival_to_osp_receiver_accdoc>
      <first_document_created_date>2017-03-30</first_document_created_date>
      <draft_last_update>2017-03-30</draft_last_update>
      <derrival_from_osp_sender>2017-03-29</derrival_from_osp_sender>
      <derrival_from_osp_receiver_accdoc>2017-03-30</derrival_from_osp_receiver_accdoc>
      <arrival_to_osp_receiver>2017-03-30</arrival_to_osp_receiver>
      <arrival_to_osp_receiver_max>2017-03-30</arrival_to_osp_receiver_max>
      <giveout_from_osp_receiver>2017-03-30 00:00:00</giveout_from_osp_receiver>
      <giveout_from_osp_receiver_max>2017-03-30 00:00:00</giveout_from_osp_receiver_max>
      <processing_date>2017-03-25</processing_date>
      <derrival_from_osp_receiver>2017-03-30</derrival_from_osp_receiver>
      <derrival_from_osp_receiver_max>2017-03-30</derrival_from_osp_receiver_max>
      <warehousing>2017-03-30</warehousing>
      <decline_date>2017-03-30</decline_date>
      <pickup>2017-03-28</pickup>
   </order_dates>
   <order_time_in_days>
      <delivery>0</delivery>
      <delivery_accdoc />
   </order_time_in_days>
   <documents>
      <create_date>2018-12-12 17:36:58</create_date>
      <document_id>15-01905000217</document_id>
      <document_type>shipping</document_type>
      <document_uid>0x9bcf2e07c8ff70e84bd7e62b335779c3</document_uid>
      <payer>
         <access>false</access>
         <is_physical>true</is_physical>
      </payer>
      <payment_state>paid</payment_state>
      <services>
         <name>Перевозка автотранспортная</name>
      </services>
      <services>
         <name>Въезд на терминал-получатель</name>
      </services>
      <total_sum>3060</total_sum>
   </documents>
</response>

Description of parameters

Response
ParameterTypeDescriptionOrder statuses
orderNumberstringOnline store order number (internal order number)All
orderDatestringOnline store order dateAll
order_idstringOrder numberAll
ordered_atstringDate of issue of the orderAll
is_containerbooleanFlag of container shippingAll
statestring

Status (in English)

All
state_namestringStatus (in Russian)All
derival_citystringCity of the senderAll, except "draft"
arrival_citystringCity of the receiverAll, except "draft"
decline_reasonstringReason for rejection"declined"
sf_request_orderedboolean

Flag meaning that delivery to the address is ordered

  • "pickup"
  • "waiting"
  • "received"
  • "received_warehousing"
  • "inway"
  • "arrived"
  • "warehousing"

sfrequest

object

Information about the order of delivery to the receiver's address

  • "pickup" *
  • "received" *
  • "received_warehousing" *
  • "inway" *
  • "arrived" *
  • "warehousing" *

* if the waybill exists and delivery to the address is available

sfrequest.pricestringCostSee object "sfrequest"
sfrequest.cityIDstringCity ID from the "Terminals" directorySee object "sfrequest"
sfrequest.docNumberstringWaybill numberSee object "sfrequest"
derival_city_idinteger

ID of the city of departure from the "Places" directory

"waiting"

derival_terminal_idinteger

ID of the terminal of departure from the "Terminals" directory

"waiting"

arrival_contact_id
integer

ID of the contact person at the terminal of arrival from the "Terminals" directory

  • "received"
  • "received_warehousing"
  • "arrived"
  • "warehousing"
arrival_city_idinteger

ID of the city of arrival from the "Places" directory

Similar to the parameter "arrival_contact_id"
arrival_cc_phonesstringCall center phone numberSimilar to the parameter "arrival_contact_id"
arrival_terminal_namestringName of the storage terminal
  • "arrived"
  • "warehousing"
arrival_terminal_citystringCity of the storage terminal
  • "arrived"
  • "warehousing"
arrival_terminal_addressstringAddress of the storage terminalSimilar to the parameter "arrival_contact_id"
arrival_terminal_phonesstringPhone number of the storage terminalSimilar to the parameter "arrival_contact_id"
arrival_terminal_emailstringE-mail of the storage terminalSimilar to the parameter "arrival_contact_id"
arrival_terminal_coordinatesarray of stringLongitude and latitude of the storage terminalSimilar to the parameter "arrival_contact_id"
worktablesobjectTimetable of the storage terminalSimilar to the parameter "arrival_contact_id"
worktables.monstringMonday timetableSimilar to the parameter "arrival_contact_id"
worktables.tuestringTuesday timetableSimilar to the parameter "arrival_contact_id"
worktables.wedstringWednesday timetableSimilar to the parameter "arrival_contact_id"
worktables.thustringThursday timetableSimilar to the parameter "arrival_contact_id"
worktables.fristringFriday timetableSimilar to the parameter "arrival_contact_id"
worktables.satstringSatureday timetableSimilar to the parameter "arrival_contact_id"
worktables.sunstringSunday timetableSimilar to the parameter "arrival_contact_id"
air_order_idintegerAir waybill number
  • "arrived_to_airport"
  • "airport_warehousing"
is_airbooleanFlag of air transportationAll
commentstringComment
  • "arrived_to_airport"
  • "airport_warehousing"
blocked_by_paymentbooleanFlag of blocking the cargo because of payment problems

All, except:

  • "draft"
  • "processing"
  • "finished"
blocked_by_blacklistboolean

Flag of unpreparedness the cargo to delivery. If the value is "true" then you need to consult with the specialists

  • "arrived"
  • "warehousing"
order_datesobjectThe estimated schedule of cargo movement (only if parameter "is_air" = "false". Otherwise, values of all parameters of this object will contain "null")All
order_dates.finishstringDate of order executionAll
order_dates.arrival_to_receiverstring

Date of the cargo delivery to the address

All
order_dates.arrival_to_osp_senderstring

Date of the cargo arrival at a separate structural subdivision of departure

All
order_dates.arrival_to_osp_receiver_accdocstring

Date of the shipping documents arrival at the terminal of arrival

All
order_dates.first_document_created_datestring

Date of creation of the first document by the order

All
order_dates.draft_last_updatestringDate of the draft last updateAll
order_dates.derrival_from_osp_senderstring

Date of the cargo departure from the terminal of departure

All
order_dates.derrival_from_osp_receiver_accdocstring

Date of the shipping documents departure from the terminal of arrival

All
order_dates.arrival_to_osp_receiverstring

Date of the cargo arrival at the terminal of arrival

All
order_dates.arrival_to_osp_receiver_maxstring

Maximum date of the cargo arrival at the terminal of arrival (if cargo arrival may be delayed)

All
order_dates.giveout_from_osp_receiverstring

Date of cargo readiness for delivery from the terminal of arrival

All
order_dates.giveout_from_osp_receiver_maxstring

Maximum date of cargo readiness for delivery from the terminal of arrival (if cargo readiness for delivery may be delayed)

All
order_dates.processing_datestring

Order processing start date

All
order_dates.derrival_from_osp_receiverstring

Date of the cargo departure from the terminal of arrival

All
order_dates.derrival_from_osp_receiver_maxstringMaximum date of the cargo departure from the terminal of arrival (if cargo departure may be delayed)
All
order_dates.warehousingstringPaid storage start dateAll
order_dates.decline_datestringRejection dateAll
order_dates.pickupstring

Date of cargo pickup from the sender's address

All
order_time_in_daysobject

Estimated delivery time (in days) (only if parameter "is_air" = "false". Otherwise, values of all parameters of this object will contain "null")

All
order_time_in_days.deliveryinteger

Estimated time of delivery cargo to the adress (in days)

All
order_time_in_days.delivery_accdocinteger

Estimated time of delivery shipping documents to the adress (in days)

All
documentsarray of Response.DocumentsList of shipping documentsAll

Response.Documents
ParameterTypeDescription
create_datestringDocument creation date
document_idstringDocument ID
document_typestring

Document type.

Possible values:

  • "request" - order of the shipping from the sender's address
  • "shipping" - waybill
  • "request_sf" - order of delivery to the receiver's address

document_uid

stringDocument UID
payerobjectInformation about the payer
payer.accessbooleanFlag "Access to the information in this block is denied"
payer.is_physicalbooleanFlag "Physical party"
payment_statestring

Payment state.

Possible values:

  • "paid"
  • "not_paid"
  • "in_process"
servicesarray of Response.Documents.ServicesList of ordered services
total_sumfloatTotal sum in the document

Response.Documents.Services
ParameterTypeDescription
namestringName of the ordered service

There are the following order statuses in the system:

Order statuses
In EnglishIn Russian
draftЧерновик
processingВ обработке
pickupЗабор груза от адреса
waitingОжидает сдачи на терминал
declinedОтклонен

received

received_warehousing

Груз принят к перевозке
inwayГруз в пути

arrived

warehousing

Груз прибыл на терминал

arrived_to_airport

airport_warehousing

Груз прибыл в аэропорт
deliveryДоставка груза до адреса
accompanying_documents_returnВозврат сопроводительных документов
finishedЗаказ завершен

Error handling

If the barcode and online store order number are not passed and number of the order or the waybill is empty or not passed, then response will be the following. (Error description in example below: "required".)

Response example

{  
   "errors":{  
      "docid":"Требуется"
   }
}
<response>
   <errors>
      <docid>Требуется</docid>
   </errors>
</response>

If the barcode is empty and number of the order (including the online store order) or the waybill is not passed, then response will be the following. (Error description in example below: "required".)

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

{  
   "errors":{  
      "barcode":"Требуется"
   }
}
<response>
   <errors>
      <barcode>Требуется</barcode>
   </errors>
</response>

If more than one of the following parameters is simultaneously passed: barcode, order number (including the online store order number), waybill number, the following answer will be returned. (Error description in example below: "It's possible to pass only one of the next parameters: docid, barcode, orderNumber".)

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

{  
   "errors":{  
      "docid":"Возможна передача только одного из параметров: docid, barcode, orderNumber"
   }
}
<response>
   <errors>
      <docid>Возможна передача только одного из параметров: docid, barcode, orderNumber</docid>
   </errors>
</response>

If the system failed to recognize the barcode, the following response will be returned. (Error description in example below: "Barcode recognition error".)

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

{  
   "errors":{  
      "barcode":"Не удалось распознать штрих-код"
   }
}
<response>
   <errors>
      <barcode>Не удалось распознать штрих-код</barcode>
   </errors>
</response>

If the order is not found, the message will be the following (it contains the number of the requested document). (Error description in example below: "docid: Order not found, use the advanced search".)

{  
   "errors":{  
      "docid":"Заказ не найден, воспользуйтесь расширенным поиском",
      "orderNumber":"1234567"
   }
}
<response>
   <errors>
      <docid>Заказ не найден, воспользуйтесь расширенным поиском</docid>
      <orderNumber>1234567</orderNumber>
   </errors>
</response>

If the online store order date has incorrect format, the following response will be returned. (Error description in example below: "orderDate: Order not found, pass the online store order date using the next format: YYYY-MM-DD".)

{  
   "errors":{  
      "orderDate":"Заказ не найден, укажите дату ВНЗ в формате ГГГГ-ММ-ДД"
   }
}
<response>
   <errors>
      <orderDate>Заказ не найден, укажите дату ВНЗ в формате ГГГГ-ММ-ДД</orderDate>
   </errors>
</response>