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

API
Главная / API - Terminals for the selected location

Terminals for the selected location

Обновлено 06.02.2023
85 кб

General information

The service allows receiving the list of terminals for the selected city. To get the data of all the terminals use "Terminals directory" method.

Terminals search

Method request

Request structure

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

{  
   "appkey":"00000000-0000-0000-0000-000000000000",
   "sessionID":"00000000-0000-0000-0000-000000000000",
   "code":"7800000000000000000000000",
   "cityid":"2423",
   "direction":"derival"
}

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

<request>
   <appkey>00000000-0000-0000-0000-000000000000</appkey>
   <sessionID>00000000-0000-0000-0000-000000000000</sessionID>
   <code>7800000000000000000000000</code>
   <cityid>2423</cityid>
   <direction>derival</direction>
</request>

Description of parameters

Request
Request
ParameterRequiredTypeDescription
appkeyYesstringApplication key. To get the key, register
sessionIDNostringTo get the session ID, use the "User Authorization" method
codeNo*string

City CLADR code (1). See "CLADR search" page.

*One of the excluding parameters must be passed in the request: "code" or "cityID"

cityIDNo*integer

City ID, see "Places search".

*One of the excluding parameters must be passed in the request: "code" or "cityID"

directionNostring

Terminals function.

Possible values:

  • "derival" - accepting the cargo;
  • "arrival" - giving out the cargo

Note:

  1. CLADR - Classifier of Addresses of Russian Federation

Method response

Response structure

{  
   "terminals":[  
      {  
         "id":1,
         "city":"Санкт-Петербург",
         "cityID":1,
         "city_code":"7800000000000000000000000",
         "name":"Санкт-Петербург-Парнас",
         "address":"Санкт-Петербург, 1-й Верхний пер, дом № 12, литера Б",
         "default":true,
         "express":true
      }
   ]
}
<response>
   <terminals>
      <id>1</id>
      <city>Санкт-Петербург</city>
      <cityID>1</cityID>
      <city_code>7800000000000000000000000</city_code>
      <name>Санкт-Петербург-Парнас</name>
      <address>Санкт-Петербург, 1-й Верхний пер, дом № 12, литера Б</address>
      <default>true</default>
      <express>true</express>
   </terminals>
</response>

Description of parameters

Response
Response
ParameterTypeDescription
terminalsarray of Terminals

The list of terminals located in the city and in the nearest locations (if any).

If there are no terminals in the indicated city, the list of the terminals for the nearest location is provided.

The list is not ordered - the terminals are listed in accordance with their order in DB

terminals.idintegerTerminal ID from "Terminals" directory
terminals.citystringTerminal city
terminals.cityIDintegerTerminal city ID, see "Places search"
terminals.city_codestringTerminal city CLADR (1) code
terminals.namestringTerminal name
terminals.addressstringTerminal address
terminals.defaultbooleanFlag indicating that the terminal is the default city terminal. Each location present in the response has one default terminal
terminals.expressbooleanFlag indicating that the terminal accepts express cargoes

Notes:

  1. CLADR - Classifier of Addresses of Russian Federation