Рус
Рус
Присоединяйтесь к нам в социальных сетях
API населенных пунктов
В запросах обязательно указывается заголовок:
Accept: application/json Публичный API доступен любому разработчику без токена авторизации. Публичный API имеет ограниченный функционал, его можно использовать для поиска населенных пунктов, расчета тарифов по базовой ставке и отслеживания накладных.
Поиск населенных пунктов отправки по наименованию.
GET https://cabinet-api.exline.kz/api/public/v1/regions/origin Сервер вернет список населенных пунктов в которых производится сбор отправлений, названия которых начинаются на символы указанные в параметре title.
title: Начальные символы в названии населенного пункта. Минимум один символ для инициализации запроса (Обязательный параметр).
Пример запроса:
https://cabinet-api.exline.kz/api/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 – количество найденных записей
Поиск населенных пунктов доставки по наименованию
GET https://cabinet-api.exline.kz/api/public/v1/regions/destination Сервер вернет список населенных пунктов куда производится доставка отправлений, названия которых начинаются на символы указанные в параметре title.
title: Начальные символы в названии населенного пункта. Минимум один символ для инициализации запроса (Обязательный параметр).
Пример запроса:
https://cabinet-api.exline.kz/api/public/v1/regions/destination?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)
GET https://cabinet-api.exline.kz/api/public/v1/regions/origins Сервер вернет список всех населенных пунктов в которых производится сбор отправлений, в указанной стране. Внимание! В настоящий момент доступен только Казахстан (KZ).
country: ISO alpha-2 код страны (KZ, RU, UA, ...)(Обязательный параметр).
Пример запроса:
https://cabinet-api.exline.kz/api/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)
GET https://cabinet-api.exline.kz/api/public/v1/regions/destinations Сервер вернет список всех населенных пунктов в которых производится сбор отправлений, в указанной стране. Внимание! В настоящий момент доступен только Казахстан (KZ).
country: ISO alpha-2 код страны (KZ, RU, UA, ...)(Обязательный параметр).
Пример запроса:
https://cabinet-api.exline.kz/api/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":22,"title":"Талдыкорган","cached_path":"Казахстан, Алматинская область",
"zone":"kz_1","origin":true,"destination":true}
],
"meta": {
"total": 28
}
}
id – id населенного пункта
title – Наименование населенного пункта
cached_path – Принадлежность к региону
zone – Тарифная зона
origin – Есть ли сбор
destination – Есть ли доставка
meta: total – количество найденных записей
Расчет тарифа
GET https://cabinet-api.exline.kz/api/public/v1/calculate Сервер вернет стоимость доставки и краткую информацию по срокам доставки.
origin_id: ID города отправки (откуда).(Обязательный параметр).
destination_id: ID города доставки (куда).(Обязательный параметр).
weight: Вес отправления в кг. Можно передавать как float так и integer значения. (Обязательный параметр).
service: Вид услуги. Может быть standard, express_mail или express_parcels..(Обязательный параметр).
declared_value: Объявленная ценность. По умолчанию 15000.
w: Ширина отправления в см.
l: Длина отправления в см.
h: Высота отправления в см.
secret: Необязательный параметр. Если указан, то расчет будет произведен согласно условиям договора контрагента.
Пример запроса:
GET https://cabinet-api.exline.kz/api/public/v1/calculate?origin_id=4&destination_id=3&weight=2.1&service=standard Ответ сервера:
{
"calculation": {
"price": "3000.00",
"fuel_surplus": "300.00",
"declared_value_fee": "150.00",
"vat": "0.00",
"human_range": "24 декабря - 26 декабря",
"min": 3,
"max": 5
}
}
price – Стоимость услуги
fuel_surplus – Стоимость услуги
declared_value_fee – Сбор за объявленную ценность
min – Минимальный срок доставки в рабочих днях
max – Максимальный срок доставки в рабочих днях
human_range – Промежуток ожидаемой доставки в удобном виде (с учетом выходных и праздников)
Пример запроса и ответа без указания в запросе услуги
GET https://cabinet-api.exline.kz/api/public/v1/calculate/all?origin_id=3&destination_id=3&weight=2.1 Ответ сервера:
{
"calculations": {
"standard": {
"price": "3000.00",
"fuel_surplus": "300.00",
"declared_value_fee": "150.00",
"vat": "0.00",
"human_range": "24 декабря - 26 декабря",
"min": 3,
"max": 5
},
"express_mail": {
"price": "4350.00",
"fuel_surplus": "435.00",
"declared_value_fee": "150.00",
"vat": "0.00",
"human_range": "20 декабря - 23 декабря",
"min": 1,
"max": 2
},
"express_parcels": {
"price": "4350.00",
"fuel_surplus": "435.00",
"declared_value_fee": "150.00",
"vat": "0.00",
"human_range": "20 декабря - 23 декабря",
"min": 1,
"max": 2
}
}
}
standard – Детали расчета для стандартного тарифа
express – Детали расчета для экспресс тарифа
Расчет сроков доставки
GET https://cabinet-api.exline.kz/api/public/v1/trails Сервер вернет список доступные сроки доставки. Если не передать ни одного параметра, вернет все сроки доставки для всех населенных пунктов.
origin_id: ID города отправки (откуда).(Обязательный параметр).
destination_id: ID города доставки (куда).(Обязательный параметр).
service: Вид услуги. Может быть standard, express_mail или express_parcels.(Обязательный параметр).
Пример запроса:
GET https://cabinet-api.exline.kz/api/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 – количество найденных записей
ExLine — линия надежной доставки!
