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

API
Главная / API - Other directories

Other directories

Обновлено 06.07.2020
221 кб

General information

This service allows you to get data from other directories that are not mentioned in other sections.

Directory of legal forms of organization

This directory contains the list of legal forms of organization.

Method request

Request example

Method address: https://api.dellin.ru/v1/references/opf_list.json

{
   "appkey":"00000000-0000-0000-0000-000000000000",
   "title":"Отк",
   "name":"ОАО",
   "countryUID":"0x8f51001438c4d49511dbd774581edb7a"
}

Method address: https://api.dellin.ru/v1/references/opf_list.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <title>Отк</title>
   <name>ОАО</name>
   <countryUID>0x8f51001438c4d49511dbd774581edb7a</countryUID>
</request>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstringApplication key. To get the key, register
titleNo*string

Full legal form name or its fragment. Minimum string length - 3 characters.

Search by the beginning and by the end of the string.

*Only one of the following parameters can be passed in a request: "title" or "name"

nameNo*string

Short name of the legal form (ООО, ОАО, etc.).

Search from the beginning of the string, exact match is required.

*Only one of the following parameters can be passed in a request: "title" or "name"

countryUIDNostringCountry UID from Countries directory

Method response

Response example

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "uid":"0x8390b2048d37e0154b845fb22793e865",
         "name":"ОАО",
         "juridical":"true",
         "title":"Открытое Акционерное Общество",
         "innLength":10,
         "countryUID":"0x8f51001438c4d49511dbd774581edb7a"
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <uid>0x8390b2048d37e0154b845fb22793e865</uid>
      <name>ОАО</name>
      <juridical>true</juridical>
      <title>Открытое Акционерное Общество</title>
      <innLength>10</innLength>
      <countryUID>0x8f51001438c4d49511dbd774581edb7a</countryUID>
   </data>
</response>

Description of parameters

Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusintegerEmulated status http-code. If successful, code 200 is returned
metadata.generated_atstring

Server response date and time.

Format: YYYY-MM-DD HH:MM:SS

dataarray of DataInformation on legal form
data.uidstringLegal form UID
data.namestringShort name of the legal form (ООО, ОАО, etc.)
data.juridicalbooleanLegal entity indicator
data.titlestringFull legal form name
data.innLengthintegerRequired number of digits in TIN
data.countryUIDstringCountry UID from Countries directory

Error handling

The common API errors are used with the method, for errors format description and errors list see Errors of API methods.

Directory of order statuses

Method request

Request example

Method address: https://api.dellin.ru/v1/references/statuses.json

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "uid":"0x8390b2048d37e0154b845fb22793e865",
         "name":"ОАО",
         "juridical":"true",
         "title":"Открытое Акционерное Общество",
         "innLength":10,
         "countryUID":"0x8f51001438c4d49511dbd774581edb7a"
      }
   ]
}

Method address: https://api.dellin.ru/v1/references/statuses.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstringApplication key. To get the key, register

Method response

Response example

{
   "metadata":{
      "status":200,
      "generated_at":"2015-06-18 12:37:28"
   },
   "data":[
      {
         "status":"processing",
         "title":"В обработке"
      }
   ]
}
<response>
   <metadata>
      <status>200</status>
      <generated_at>2015-06-18 12:37:28</generated_at>
   </metadata>
   <data>
      <status>processing</status>
      <title>В обработке</title>
   </data>
</response>

Description of parameters

Response
ParameterTypeDescription
metadataobjectSystem information
metadata.statusintegerEmulated status http-code. If successful, code 200 is returned
metadata.generated_atstring

Server response date and time.

Format: YYYY-MM-DD HH:MM:SS

dataarray of DataInformation on order status
data.statusstringOrder status. For parameter values see table below
data.titlestringOrder status name in Russian. For parameter values see table below

"response.data.status" and "response.data.title" parameters values
The table below lists "response.data.status" parameter values and corresponding values of "response.data.title" parameter

data.status

data.title

Notes
draftЧерновик-
processingВ обработке-
pickupЗабор груза от адресаCargo pickup at the sender's address
waitingОжидает сдачи на терминал-
declinedОтклонен-
receivedГруз принят к перевозке-
received_warehousingГруз принят к перевозке. Платное хранение-
inwayГруз в пути-
arrivedГруз прибыл на терминал-
warehousingГруз прибыл на терминал. Платное хранение-
arrived_to_airportГруз прибыл в аэропорт-
airport_warehousingГруз прибыл в аэропорт. Платное хранение-
deliveryДоставка груза до адресаCargo delivery to the receiver's address
accompanying_documents_returnГруз выдан. Возврат СД-
finishedЗаказ завершен-

Error handling

The common API errors are used with the method, for errors format description and errors list see Errors of API methods.

Directory of parameters for statistics report

Method request

Request example

Method address: https://api.dellin.ru/v1/public/report_params.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Method address: https://api.dellin.ru/v1/public/report_params.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstringApplication key. To get the key, register

Method response

Response example

{  
   "hash":"0dd17e7c6e8e69455360f392577356ace95385b0a94f5a062ef07aeee46be4a0",
   "url":"http://api.dellin.stage/catalog/report_params.csv?sk=5iq56DseyHlaqmYO7atEpw&e=1506409060"
}
<response>
   <hash>0dd17e7c6e8e69455360f392577356ace95385b0a94f5a062ef07aeee46be4a0</hash>
   <url>http://api.dellin.stage/catalog/report_params.csv?sk=5iq56DseyHlaqmYO7atEpw&e=1506409060</url>
</response>

Description of parameters

Response
ParameterTypeDescription
hashstringFile hash code (MD5). By comparing the hash codes of two files received at different times, you can understand whether the data in the directory has changed or not
urlstring

Link to the file with directory data in csv format in utf-8 encoding (the link is valid for 10 minutes).

The line delimiter in the file is the character "\n", the column delimiter is comma (","), and the text delimiter is the quotation mark (" " ").

The file contains the next columns:

  • name — parameter name (key; in Latin);
  • сaption — parameter name (in Cyrillic).

It is recommended to update the downloaded file once a month

Price list

Method request

Request example

Method address: https://api.dellin.ru/v1/public/pricelist.json

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "city_from_uid":"0x834f00112fdd658311da4c6326ef0e13",
   "city_to_uid":"0x834f00112fdd658311da4c6326ef0e13"
}

Method address: https://api.dellin.ru/v1/public/pricelist.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <city_from_uid>0x834f00112fdd658311da4c6326ef0e13</city_from_uid>
   <city_to_uid>0x834f00112fdd658311da4c6326ef0e13</city_to_uid>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription
appkeyYesstringApplication key. To get the key, register

city_from_uid

No*string

UID of the city of departure, see "Places" directory

*At least one of the parameters "city_to_uid" or "city_from_uid" is required

city_to_uid

No*string

UID of the city of arrival, see "Places" directory

*At least one of the parameters "city_to_uid" or "city_from_uid" is required

Method response

Response example

{  
   "data":{  
      "header":"Межтерминальная доставка",
      "table":{  
         "caption":"Отправка из г. Москва (7 (495) 775-55-30)",
         "header":[  
            {  
               "name":"city_to",
               "text":"направление"
            },
            {  
               "name":"min_cost",
               "text":"мин. ст-ть"
            },
            {  
               "name":"weight_cost",
               "text":"стоимость за 1 кг. (руб)",
               "value":[  
                  "5000 - 10000",
                  "3000 - 5000",
                  "2000 - 3000",
                  "1500 - 2000",
                  "800 - 1500",
                  "300 - 800",
                  "150 - 300",
                  "0 - 150"
               ]
            },
            {  
               "name":"volume_cost",
               "text":"стоимость за 1 куб.м. (руб)",
               "value":[  
                  "25 - 45",
                  "15 - 25",
                  "10 - 15",
                  "7 - 10",
                  "4 - 7",
                  "1.3 - 4",
                  "0.6 - 1.3",
                  "0 - 0.6"
               ]
            }
         ],
         "body":[  
            {  
               "city_to":"Абакан",
               "min_cost":570,
               "weight_cost":[  
                  17.9,
                  18.7,
                  19.4,
                  20,
                  20.4,
                  22.3,
                  23,
                  23.7
               ],
               "volume_cost":[  
                  4650,
                  4860,
                  5040,
                  5200,
                  5300,
                  5800,
                  5980,
                  6160
               ]
            },
            {  
               "city_to":"Адлер",
               "min_cost":450,
               "weight_cost":[  
                  11.5,
                  12.2,
                  12.6,
                  12.8,
                  13.2,
                  14.4,
                  14.8,
                  15.3
               ],
               "volume_cost":[  
                  2990,
                  3170,
                  3280,
                  3330,
                  3430,
                  3740,
                  3850,
                  3980
               ]
            }
         ]
      }
   }
}
<response>
   <data>
      <header>Межтерминальная доставка</header>
      <table>
         <caption>Отправка из г. Москва (7 (495) 775-55-30)</caption>
         <thead>      
            <tr>
               <th rowspan="2">направление</th>
               <th rowspan="2" class="brighten">мин. ст-ть</th>
               <th colspan="8" class="brighten">стоимость за 1 кг. (руб)</th>
               <th colspan="8" class="brighten">стоимость за 1 куб.м. (руб)</th>
            </tr>
            <tr>
               <th class="nowrap">5000 - 10000</th>
               <th class="nowrap">3000 - 5000</th>
               <th class="nowrap">2000 - 3000</th>
               <th class="nowrap">1500 - 2000</th>
               <th class="nowrap">800 - 1500</th>
               <th class="nowrap">300 - 800</th>
               <th class="nowrap">150 - 300</th>
               <th class="nowrap">0 - 150</th>
               <th class="nowrap">25 - 45</th>
               <th class="nowrap">15 - 25</th>
               <th class="nowrap">10 - 15</th>
               <th class="nowrap">7 - 10</th>
               <th class="nowrap">4 - 7</th>
               <th class="nowrap">1.3 - 4</th>
               <th class="nowrap">0.6 - 1.3</th>
               <th class="nowrap">0 - 0.6</th>
            </tr>
         </thead> 
         <tbody>
            <tr class="odd">
               <td>Абакан</td>
               <td class="numeric">570</td>
               <td class="numeric">17.9</td>
               <td class="numeric">18.7</td>
               <td class="numeric">19.4</td>
               <td class="numeric">20</td>
               <td class="numeric">20.4</td>
               <td class="numeric">22.3</td>
               <td class="numeric">23</td>
               <td class="numeric">23.7</td>
               <td class="numeric">4650</td>
               <td class="numeric">4860</td>
               <td class="numeric">5040</td>
               <td class="numeric">5200</td>
               <td class="numeric">5300</td>
               <td class="numeric">5800</td>
               <td class="numeric">5980</td>
               <td class="numeric">6160</td>
            </tr>
            <tr class="odd">
               <td>Адлер</td>
               <td class="numeric">450</td>
               <td class="numeric">11.5</td>
               <td class="numeric">12.2</td>
               <td class="numeric">12.6</td>
               <td class="numeric">12.8</td>
               <td class="numeric">13.2</td>
               <td class="numeric">14.4</td>
               <td class="numeric">14.8</td>
               <td class="numeric">15.3</td>
               <td class="numeric">2990</td>
               <td class="numeric">3170</td>
               <td class="numeric">3280</td>
               <td class="numeric">3330</td>
               <td class="numeric">3430</td>
               <td class="numeric">3740</td>
               <td class="numeric">3850</td>
               <td class="numeric">3980</td>
            </tr>
         </tbody>
      </table>
   </data>
</response>

Description of parameters

Response
Response
ParameterTypeDescription

data

objectInformation on rates
data.headerstringTable name
data.tableTableTable with rates

Table
JSON object structure is different from XML object structure, see the description of each of the formats below
JSON
Table
ParameterTypeDescription

caption

string

Information about the direction of transportation

header

array of HeaderHeadings of the table columns

header.name

stringColumn heading (name of the corresponding parameter of the "body" object)
header.textstringColumn heading (textual representation, in Russian)

header.value

array of stringsValue ranges (names of the sub-columns of the column)
bodyarray of BodyTable body
city_fromstring

City of departure

The parameter is present in the response only if "city_to_uid" parameter is passed in the request, meanwhile "city_from_uid" is not passed
city_tostring

City of arrival

The parameter is present in the response only if "city_from_uid" parameter is passed in the request, meanwhile "city_to_uid" is not passed
min_costintegerMinimal price, rub.
weight_costarray of floatPrice, rub./kg. Values of the relevant weight ranges transferred in "header.value" parameter (of the "" object that has "header.name" parameter with "weight_cost" value)
volume_costarray of integerPrice, rub./m3. Values of the relevant volume ranges transferred in "header.value" parameter (of the "" object that has "header.name" parameter with "volume_cost" value)
XML
Table
ParameterTypeDescription

caption

stringInformation about the direction of transportation
theadarray of TableRowHeadings of the table columns
tbodyarray of TableRowTable body
TableRow
ParameterTypeDescription

tr

array of TrTable row content
tr.tharray of strings

Content of the table cell of the heading

For  "thead.tr" object only
tr.tdarray of strings

Table cell content

For  "tbody.tr" object only

Error handling

If the request misses of required parameters, the following error message will be displayed:

Response example - Required parameters not passed

{  
   "errors":"Некорректный запрос"
}
<response>
   <errors>Некорректный запрос</errors>
</response>

If the required parameter value is empty, the following error message will be displayed:

Response example - Required parameters values are empty

{  
   "errors":{  
      "city_from_uid":"Это поле не может быть пустым."
   }
}
<response>
   <errors>
      <city_from_uid>Это поле не может быть пустым.</city_from_uid>
   </errors>
</response>

If the parameter value is incorrect, the following error message will be displayed:

Response example - Incorrect parameters values passed

{
   "errors":{
      "city_from_uid": "Некорректный uid города",
      "city_to_uid": "Некорректный uid города"
   }
}
<response>
   <errors>
      <city_from_uid>Некорректный uid города</city_from_uid>
      <city_to_uid>Некорректный uid города</city_to_uid>
   </errors>
</response>

Documents for receipt of cargo

This directory contains the list of documents for receipt of cargo.

Method request

Request example

Method address: https://api.dellin.ru/v1/public/documents_for_receive.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Method address: https://api.dellin.ru/v1/public/documents_for_receive.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstringApplication key. To get the key, register

Method response

Response example

{
   "hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4",
   "url": "https://api.dellin.ru/catalog/documents_for_receive.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434"
}
<response>
   <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash>
   <url>https://api.dellin.ru/catalog/documents_for_receive.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url>
</response>

Description of parameters

Response
ParameterTypeDescription
hashstringFile hash code (MD5). By comparing the hash codes of two files received at different times, you can understand whether the data in the directory has changed or not
urlstring

Link to the file with directory data in csv format in utf-8 encoding (the link is valid for 10 minutes).

The line delimiter in the file is the character "\n", the column delimiter is comma (","), and the text delimiter is the quotation mark (" " ").

The file contains the next columns:

  • UID — unique identifier;
  • name — name of the document for receipt cargo;
  • day_to_day — flag indicating the possibility of receiving cargo on the same day using this document.

It is recommended to update the downloaded file once a month

Nature of cargo

This directory contains the list of types of nature of cargo.

Method request

Request example

Method address: https://api.dellin.ru/v1/public/freight_types.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Method address: https://api.dellin.ru/v1/public/freight_types.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstringApplication key. To get the key, register

Method response

Response example

{
   "hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4",
   "url": "https://api.dellin.ru/catalog/freight_types.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434"
}
<response>
   <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash>
   <url>https://api.dellin.ru/catalog/freight_types.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url>
</response>

Description of parameters

Response
ParameterTypeDescription
hashstringFile hash code (MD5). By comparing the hash codes of two files received at different times, you can understand whether the data in the directory has changed or not
urlstring

Link to the file with directory data in csv format in utf-8 encoding (the link is valid for 10 minutes).

The line delimiter in the file is the character "\n", the column delimiter is comma (","), and the text delimiter is the quotation mark (" " ").

The file contains the next columns:

  • UID — unique identifier;
  • description — name of the nature of cargo.

It is recommended to update the downloaded file once a month

Directory of legal forms of organization (old)

The method is outdated. Use Directory of legal forms of organization method instead

This directory contains the list of legal forms of organization.

Method request

Request example

Method address: https://api.dellin.ru/v1/public/opf_list.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Method address: https://api.dellin.ru/v1/public/opf_list.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstringApplication key. To get the key, register

Method response

Response example

{
   "hash": "1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4",
   "url": "https://api.dellin.ru/catalog/opf_list.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434"
}
<response>
   <hash>1707aea20f301fd0a8787b5a68608dd6cf270347ea04c266f1b4c6aa540088a4</hash>
   <url>https://api.dellin.ru/catalog/opf_list.csv?sk=Kn0OtWJcumDYUqRjtCEvhg&e=1401285434</url>
</response>

Description of parameters

Response
ParameterTypeDescription
hashstringFile hash code (MD5). By comparing the hash codes of two files received at different times, you can understand whether the data in the directory has changed or not
urlstring

Link to the file with directory data in csv format in utf-8 encoding (the link is valid for 10 minutes). The line delimiter in the file is the character "\n", the column delimiter is comma (","), and the text delimiter is the quotation mark (" " ").

The file contains the next columns:

  • UID — unique identifier;
  • name — short name of legal form of organization ("ООО", "ОАО", etc.);
  • juridical — flag of juridical party ("1" - yes, "0" - no);
  • fullName — full name of legal form of organization;
  • innLength — number of digits in TIN;
  • countryUID — unique country identifier.

Directory of order statuses (old)

The method is outdated. Use Directory of order statuses method instead

Method request

Request example

Method address: https://api.dellin.ru/v1/public/statuses.json

{
   "appkey": "00000000-0000-0000-0000-000000000000"
}

Method address: https://api.dellin.ru/v1/public/statuses.xml

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
</request>

Description of parameters

Request
ParameterR*TypeDescription
appkeyYesstringApplication key. To get the key, register

Method response

Response example

{  
   "hash":"db090d4a0111cc5a7a2282716218840972a65251651a4fb2dc8f6ea34e5d2fa0",
   "url":"https://api.dellin.ru/catalog/statuses.json?sk=0k92VHh-Am_cUX6qsvdEjQ&e=1496046122"
}
<response>
   <hash>db090d4a0111cc5a7a2282716218840972a65251651a4fb2dc8f6ea34e5d2fa0</hash>
   <url>https://api.dellin.ru/catalog/statuses.json?sk=0k92VHh-Am_cUX6qsvdEjQ&e=1496046122</url>
</response>

Description of parameters

Response
ParameterTypeDescription
hashstringFile hash code (MD5). By comparing the hash codes of two files received at different times, you can understand whether the data in the directory has changed or not
urlstring

Link to the file with directory data in json format