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

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

Other directories

Обновлено 06.12.2019
169 кб

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

Fragment of the full legal form name. Minimal string length - 3 characters.

Search by the beginning and by the end of the string. Exact match is not required.

*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" parameter values
The table below lists "response.data.status" parameter values and corresponding values of "response.data.title" parameter

data.status

data.title

Примечание
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)

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.

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.

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