Order search by incomplete data
General information
The service allows to search orders using following data: TIN (for legal entities), type and document number (for individuals), route and order dispatch date.
Order search by incomplete data
Method request
Request example
Method address: https://api.dellin.ru/v2/tracker_advanced.json
{ "appkey":"00000000-0000-0000-0000-000000000000", "sender":{ "inn":"7122963715", "docType":"passport", "docSeries":"4007", "docNumber":"451735", "terminal":"7800000000000000000000000" }, "receiver":{ "inn":"4516374515", "docType":"foreignPassport", "docSeries":"4008", "docNumber":"236782", "terminal":"7700000000000000000000000" }, "dateStart":"2015-08-10", "dateEnd":"2015-08-17" }
Method address:: https://api.dellin.ru/v2/tracker_advanced.xml
<request> <appkey>00000000-0000-0000-0000-000000000000</appkey> <sender> <inn>7122963715</inn> <docType>passport</docType> <docSeries>4007</docSeries> <docNumber>451735</docNumber> <terminal>7800000000000000000000000</terminal> </sender> <receiver> <inn>4516374515</inn> <docType>foreignPassport</docType> <docSeries>4008</docSeries> <docNumber>236782</docNumber> <terminal>7700000000000000000000000</terminal> </receiver> <dateStart>2015-08-10</dateStart> <dateEnd>2015-08-17</dateEnd> </request>
Описание параметров
Request
Request | |||
---|---|---|---|
Parameter | Required | Type | Description |
appkey | Yes | string | Application key. To get the key, register |
sender | No | Member | Sender data |
receiver | No | Member | Receiver data |
dateStart | Yes | string | Period start date (the parameter is used to filter search results by order dispatch period). Format: YYYY-MM-DD The interval between the start and the end dates must not exceed 7 days. |
dateEnd | Yes | string | Period end date (the parameter is used to filter search results by order dispatch period). Format: YYYY-MM-DD The interval between the start and the end dates must not exceed 7 days. |
Member
Member | |||
---|---|---|---|
Parameter | Required | Type | Description |
inn | No | string | TIN - taxpayer identification number (for legal entities). Allowed number of characters may vary depending on country and legal form of organization |
docType | No | string | ID type (for individuals) Possible values:
|
docSeries | No | string | ID type (for individuals) |
docNumber | No | string | ID number (for individuals). Number format may vary depending on the country |
terminal | No | string | CLADR* code of point of departure (for object) or delivery (for request.receiver object). To get CLADR code use the services listed on Using CLADR codes page (CLADR - Classifier of Addresses of the Russian Federation) |
Method response
Response example
{ "metadata":{ "status":200, "generated_at":"2015-06-18 12:37:28" }, "data":{ "orderNumbers":[ "19-00395029101", "19-00395029585", "19-0039514523" ] } }
<response> <metadata> <status>200</status> <generated_at>2015-06-18 12:37:28</generated_at> </metadata> <data> <orderNumbers>19-00395029101</orderNumbers> <orderNumbers>19-00395029585</orderNumbers> <orderNumbers>19-0039514523</orderNumbers> </data> </response>
Description of parameters
Response
Response | ||
---|---|---|
Parameter | Type | Description |
metadata | object | System information |
metadata.status | integer | Emulated status http-code. If successful, code 200 is returned |
metadata.generated_at | string | Server response date and time. Format: YYYY-MM-DD HH:MM:SS |
data | object | Orders data |
data.orderNumbers | array of strings | Orders numbers found |
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 | ||
714001 | 400 | Ничего не найдено | No orders found | - | - |
714002 | 400 | Уточните параметры поиска. Количество найденных заказов превышает лимит | Please, refine your search. The number of orders found exceeds the limit | - | - |
714003 | 400 | Данные участника перевозки введены неверно | Transportation participant data are incorrect | - | - |
714004 | 400 | Не найден участник перевозки по указанным данным (sender) | Transportation participant (sender) with the specified data is not found | - | - |
714005 | 400 | Не найден участник перевозки по указанным данным (receiver) | Transportation participant (receiver) with the specified data is not found | - | - |
714006 | 400 | Найдено более 5 накладных | More than 5 waybills found | - | - |
714007 | 400 | Период указан неверно | The interval is not correct | Диапазон дат выполнения заказа не должен превышать 7 дней | The interval between the start and the end dates must not exceed 7 days |