API: идентификатор города в СДЭК, Boxberry и DPD

Службы доставки часто используют собственные идентификаторы городов, и требуют от магазина указывать их в заказе.

Метод findById/delivery определяет идентификатор города в службе доставке на основании КЛАДР-кода города.

Пока поддерживаются службы доставки СДЭК, Boxberry и DPD. Если вам нужны идентификаторы других сервисов — напишите в службу поддержки

Как вызвать

Чтобы вызвать метод, зарегистрируйтесь и подтвердите почту.

Пример запроса:

            
                POST https://suggestions.dadata.ru/suggestions/api/4_1/rs/findById/delivery
            
            

                

                    { "query": "3100400100000" }
                
                
            
        

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Token ${API_KEY}" \ 
  -d '{ "query": "3100400100000" }' \
  https://suggestions.dadata.ru/suggestions/api/4_1/rs/findById/delivery

// https://github.com/hflabs/dadata-csharp

var token = "${API_KEY}";
var api = new SuggestClientAsync(token);
var result = await api.FindDelivery("3100400100000");
var city = response.suggestions[0].data;

var url = "https://suggestions.dadata.ru/suggestions/api/4_1/rs/findById/delivery";
var token = "${API_KEY}"; 
var query = "3100400100000";

var options = {
    method: "POST",
    mode: "cors",
    headers: {
        "Content-Type": "application/json",
        "Accept": "application/json",
        "Authorization": "Token " + token 
    },
    body: JSON.stringify({query: query})
}

fetch(url, options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log("error", error));

// https://github.com/hflabs/dadata-php

$token = "${API_KEY}";
$dadata = new \Dadata\DadataClient($token, null);
$result = $dadata->findById("delivery", "3100400100000", 1);

# https://github.com/hflabs/dadata-py

from dadata import Dadata
token = "${API_KEY}"
dadata = Dadata(token)
result = dadata.find_by_id("delivery", "3100400100000")

Укажите при вызове:

• Content-Type: application/json.
• Accept: application/json.
• ${API_KEY} — API-ключ.

Тело запроса передавайте в кодировке UTF-8.

Что в ответе

Ответ:

{
    "suggestions": [
        {
            "value": "3100400100000",
            "unrestricted_value": "fe7eea4a-875a-4235-aa61-81c2a37a0440",
            "data": {
                "kladr_id": "3100400100000",
                "fias_id": "fe7eea4a-875a-4235-aa61-81c2a37a0440",
                "boxberry_id": "01929",
                "cdek_id": "344",
                "dpd_id": "196006461"
            }
        }
    ]
}

Если для указанного КЛАДР-кода ничего не найдено, ответ будет таким:

{
    "suggestions": []
}

Поля в ответе

Примеры вызова

• npm-пакет
• Laravel
• PHP
• Python
• R
• Symfony

Ограничения

Длина запроса (параметр query) — не более 300 символов.

Количество запросов в день — в соответствии с тарифным планом.

Максимальная частота запросов — 30 в секунду с одного IP-адреса.

Максимальная частота создания новых соединений — 60 в минуту с одного IP-адреса.

Стоимость

Метод бесплатный до 10 000 запросов в день. Больше — в составе годовой подписки.