API населенных пунктов

В запросах обязательно указывается заголовок:

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

Поиск населенных пунктов отправки по наименованию.

Сервер вернет список населенных пунктов в которых производится сбор отправлений, названия которых начинаются на символы указанные в параметре title.

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

Ответ сервера:

        
{
  "regions":
    [
      { "id":4,"title":"Астана","cached_path":"Казахстан" },
      { "id":124,"title":"Астрахань","cached_path":"Россия, Астраханская область" }
    ],
  "meta":{ "total":2 }
}
        
      

id – id населенного пункта

title – Наименование населенного пункта

cached_path – Принадлежность к региону

meta: total – количество найденных записей

Поиск населенных пунктов доставки по наименованию

Сервер вернет список населенных пунктов куда производится доставка отправлений, названия которых начинаются на символы указанные в параметре title.

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

Ответ сервера:

        
{
  "regions":
    [
      { "id":4,"title":"Астана","cached_path":"Казахстан" },
      { "id":124,"title":"Астрахань","cached_path":"Россия, Астраханская область" }
    ],
  "meta":{ "total":2 }
}
        
      

id – id населенного пункта

title – Наименование населенного пункта

cached_path – Принадлежность к региону

meta: total – количество найденных записей

Все населенные пункты отправки по коду страны (alpha-2 ISO)

Сервер вернет список всех населенных пунктов в которых производится сбор отправлений, в указанной стране. Внимание! В настоящий момент доступен только Казахстан (KZ).

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

Ответ сервера:

        
{
  "regions":
    [
      {"id":3,"title":"Астана","cached_path":"Казахстан","zone":"kz_1",
            "origin":true,"destination":true},
      {"id":5,"title":"Байконур","cached_path":"Казахстан","zone":"kz_2",
            "origin":true,"destination":true},
      ...
      {"id":22,"title":"Талдыкорган","cached_path":"Казахстан, Алматинская область",
            "zone":"kz_1","origin":true,"destination":true}
    ],
  "meta":{"total":28}
}
        
      

id – id населенного пункта

title – Наименование населенного пункта

cached_path – Принадлежность к региону

zone – Тарифная зона

origin – Есть ли сбор

destination – Есть ли доставка

meta: total – количество найденных записей

Все населенные пункты отправки по коду страны (alpha-2 ISO)

Сервер вернет список всех населенных пунктов в которых производится сбор отправлений, в указанной стране. Внимание! В настоящий момент доступен только Казахстан (KZ).

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

Ответ сервера:

        
{
  "regions":
    [
      {"id":3,"title":"Астана","cached_path":"Казахстан","zone":"kz_1",
            "origin":true,"destination":true},
      {"id":5,"title":"Байконур","cached_path":"Казахстан","zone":"kz_2",
            "origin":true,"destination":true},
      ...
      {"id":22,"title":"Талдыкорган","cached_path":"Казахстан, Алматинская область",
            "zone":"kz_1","origin":true,"destination":true}
    ],
  "meta": {"total":28}
}
        
      

id – id населенного пункта

title – Наименование населенного пункта

cached_path – Принадлежность к региону

zone – Тарифная зона

origin – Есть ли сбор

destination – Есть ли доставка

meta: total – количество найденных записей

Расчет тарифа

Сервер вернет стоимость доставки и краткую информацию по срокам доставки.

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

Ответ сервера:

        
{
  "calculation": {
          "price": 3950,
          "fuel_surplus":395,
          "human_range":"05 - 07 апреля","min":1,"max":2
          }
}
        
      

price – Стоимость услуги

fuel_surplus – Стоимость услуги

declared_value_fee – Сбор за объявленную ценность

min – Минимальный срок доставки в рабочих днях

max – Максимальный срок доставки в рабочих днях

human_range – Промежуток ожидаемой доставки в удобном виде (с учетом выходных и праздников)

Пример запроса и ответа без указания в запросе услуги

Ответ сервера:

        
{
  "calculations": {
    "standard": {
      "price":1400,
      "fuel_surplus":140,
      "human_range":"14 – 16 апреля",
      "min":7,
      "max":9,
      "id":2
    },
    "express": {
      "price":1800,
      "fuel_surplus":180,
      "human_range":"06 – 08 апреля",
      "min":1,
      "max":3
    }
  }
}
        
      

standard – Детали расчета для стандартного тарифа

express – Детали расчета для экспресс тарифа

Расчет сроков доставки

Сервер вернет список доступные сроки доставки. Если не передать ни одного параметра, вернет все сроки доставки для всех населенных пунктов.

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

Ответ сервера:

        
{
 "trails":
    [
      {"id":3,
      "service":"express",
      "origin":"Алматы",
      "destination":"Астана",
      "min":1,
      "max":3,
      "min_date":"2015-03-06",
      "max_date":"2015-03-11",
      "human_range":"06 – 11 марта",
      "definitely_holidays":[],
      "maybe_holidays":["Международный женский день"],
      "definitely_weekends":[],
      "maybe_weekends":["2015-03-07","2015-03-08"]}
    ],
  "meta":{"total":1}
}
        
      

origin – Пункт отправки

destination – Пункт доставки

min – Минимальный срок доставки в рабочих днях

max – Максимальный срок доставки в рабочих днях

min_date – Минимальная дата доставки (с учетом выходных и праздников)

max_date – Максимальная дата доставки (с учетом выходных и праздников)

human_range – Промежуток ожидаемой доставки в удобном виде

definitely_holidays – Праздники, которые точно приходятся на срок доставки

maybe_holidays – Праздники, которые вероятно могут попасть на срок доставки

definitely_weekends – Выходные (суббота, воскресенье), которые точно приходятся на срок доставки

maybe_weekends – Выходные (суббота, воскресенье), которые вероятно могут попасть на срок доставки

meta: total – количество найденных записей