Rest API Exline

Документация для разработчиков. Создавайте приложения и интегрируйтесь с информационными системами Exline.

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

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

https://api.exline.systems/public/v1/regions/origin

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

ПараметрОписание

title

Обязательный параметр
Начальные символы в названии населенного пункта. Минимум один символ для инициализации запроса.
https://api.exline.systems/public/v1/regions/origin?title=Аст
{"regions":
  [
    {"id":4,"title":"Астана","cached_path":"Казахстан"},
    {"id":124,"title":"Астрахань","cached_path":"Россия, Астраханская область"}
  ],
"meta":{"total":2}}

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

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

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

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

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

https://api.exline.systems/public/v1/regions/destination

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

ПараметрОписание

title

Обязательный параметр
Начальные символы в названии населенного пункта. Минимум один символ для инициализации запроса.
https://api.exline.systems/public/v1/regions/destination?title=Еси
{"regions":
  [
    {"id":31,"title":"Есиль","cached_path":"Казахстан, Акмолинская область"},
    {"id":47,"title":"Есик","cached_path":"Казахстан, Алматинская область"}
  ],
"meta":{"total":2}}

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

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

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

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

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

https://api.exline.systems/public/v1/regions/origins

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

ПараметрОписание

country

Обязательный параметр
ISO alpha-2 код страны (KZ, RU, UA, ...)
https://api.exline.systems/public/v1/regions/origins?country=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)

https://api.exline.systems/public/v1/regions/destinations

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

ПараметрОписание

country

Обязательный параметр
ISO alpha-2 код страны (KZ, RU, UA, ...)
https://api.exline.systems/public/v1/regions/destinations?country=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":317,"title":"Курчатов","cached_path":"Казахстан, Восточно-Казахстанская область","zone":"kz_2","origin":false,"destination":true}
  ],
"meta":{"total":163}}

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

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

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

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

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

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

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

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

https://api.exline.systems/public/v1/calculate

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

ПараметрОписание

origin_id

Обязательный параметр
ID города отправки (откуда).

destination_id

Обязательный параметр
ID города доставки (куда).

weight

Обязательный параметр
Вес отправления в кг. Можно передавать как float так и integer значения.

service

Обязательный параметр
Вид услуги. Может быть standard или express.

declared_value

Объявленная ценность. По умолчанию 15000.

w

Ширина отправления в см.

l

Длина отправления в см.

h

Высота отправления в см.
https://api.exline.systems/public/v1/calculate?origin_id=4&destination_id=20&weight=2.1&service=express
{"calculation":{"price": 3950,"fuel_surplus":395,"human_range":"05 - 07 апреля","min":1,"max":2}}

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

fuel_surplus – Топливная надбавка

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

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

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

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

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

https://api.exline.systems/public/v1/calculate?origin_id=3&destination_id=12&weight=2.1
{"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 – Детали расчета для экспресс тарифа

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

https://api.exline.systems/public/v1/trails

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

ПараметрОписание

origin_id

ID пункта отправления (откуда).

destination_id

ID пункта доставки (куда).

service

Вид услуги. Может быть standard или express.
https://api.exline.systems/public/v1/trails?origin_id=4&destination_id=3&service=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 – количество найденных записей