Rest API Блицпочты

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

Документация клиентского API

Клиентский API доступен только клиентам Exline по специальному токену. С помощью клиентского API можно произвести полную интеграцию с сервисами Exline. Для получения токена и регистрации вашего приложения обратитесь по электронной почте orca@exline.kz.

Получение списка накладных

https://api.exline.systems/client/v1/waybills

API вернет список ваших накладных согласно указанным фильтрам.

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

start_date

Дата создания накладной (от). Если параметр end_date не указан, то будут возвращены накладные по текущее время.

end_date

Дата создания накладной (по). Если параметр start_date не указан, то будут возвращены все накладные вплоть до end_date.

delivered

Возвращает закрытые (доставленные) или не закрытые (не доставленные) накладные. Может быть true или false. Если параметр не указан, возвращает накладные с обоими статусами.

code

Возвращает накладную по ее номеру. Если номер указан, то вернет только одну накладную, так как номер уникальный.

ref_number

Возвращает накладную по номеру клиента (номер передается при созданиии накладной). Номер не уникальный, поэтому может вернуть несколько накладных.
https://api.exline.systems/client/v1/waybills?delivered=false
{"waybills":
  [
    { 
      "id":"1133440",
      "code":"1932443115",
      "ref_number":"1023133",
      "draft":false,
      "delivered":false,
      "created_at"::"2016.02.17 10:35 UTC",
      "collected_at":"2016.02.17 14:35 UTC",
      "expire_date":"2016.02.19",
      "origin_region_id":1,
      "origin_region_title":"Алматы",
      "origin_address":"ул. Абая, 76А",
      "destination_region_id":3,
      "destination_region_title":"Астана",
      "destination_address":"пр. Орынбор, 12, офис 7",
      "payment_method":"bank",
      "pricing_policy":"1600 с топливной надбавкой и с минимальной объявленной ценностью 2015",
      "price":1600,
      "declared_value":15000,
      "declared_value_fee":120,
      "fuel_surplus":160,
      "additional_services_price":0,
      "sender_title":"Иванов",
      "sender_phone":"+7 (701) 500 45 67",
      "receiver_title":"Сидоров",
      "receiver_phone":"+7 (7172) 503 503",
      "service":"express_mail",
      "service_translate":"Экспресс пакеты",
      "qty":1,
      "total_weight":0.3,
      "notes":""
    },
    {...},
    {...}
  ]

code – Номер накладной

ref_number – Дополнительный номер (номер клиента)

draft – Черновой вариант/В работе. Любая созданная накладная через API имеет draft: true.

delivered – Доставлено/Не доставлено

ref_number – Дополнительный номер (номер клиента)

created_at – Время создания накладной

collected_at – Время сбора отправлений курьером

expire_date – Крайняя дата доставки

origin_region_id – ID региона отправки

origin_region_title – Наименование региона отправки

origin_address – Адрес отправки

destination_region_id – ID региона доставки

destination_region_title – Наименование региона доставки

destination_address – Адрес доставки

payment_method – Способ оплаты. cash – наличными, bank – банковский перевод, electronic – платежные терминалы и карты

pricing_policy – Тарифная сетка

price – Основной тариф

declared_value – Объявленная ценность

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

fuel_surplus – Топливный сбор

additional_services_price – Стоимость дополнительных услуг

sender_title – Наименование отправителя

sender_phone – Телефон отправителя

receiver_title – Наименование получателя

receiver_phone – Телефон получателя

service – Код услуги

service_translate – Перевод кода услуги

qty – Количество отправлений

total_weight – Общий вес (округленный для расчета)

notes – Примечания

Получение списка изменений по накладной

https://api.exline.systems/client/v1/waybills/:id/audit

API вернет список всех изменений зарегистрированных по накладной.

https://api.exline.systems/client/v1/waybills/1234567116/audit
{"audits":
  [
    { 
      "id":"1133440",
      "created_at"::"2016.02.17 10:35 UTC",
      "action":"update",
      "version":2,
      "changes":
        [
          {
            "attribute":"declared_value",
            "before":15000,
            "after":35000,
          },
          {
            "attribute":"receiver_phone",
            "before":"+7 (701) 500 45 67",
            "after":"+7 (777) 123 45 59",
          },
        ],
    },
    {...},
    {...}
  ]

created_at – Время регистрации изменений

action – Тип изменений. update – изменение, destroy – удаление

version – Версия изменения.

changes.attribute – Измененный атрибут

changes.before – Предыдущее значение атрибута

changes.after – Новое значение атрибута

Регистрация заявки

Если вы регистрируете заявку, требуется использовать бумажный вариант накладной. API регистрации электронной накладной не требуется!

https://api.exline.systems/client/v1/orders/new

API вернет номер созданной заявки со статусом 204. В случае, если данные не валидны будет возврашен статус 422. Созданная заявка сразу же уходит в работу.

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

sender_title

Обязательный параметр
Наименование отправителя

sender_phone

Обязательный параметр
Телефон отправителя

region_id

Обязательный параметр
ID региона отправки. Получить список регионов можно в публичном API.

collect_address

Обязательный параметр
Адрес отправки

desired_date

Обязательный параметр
Желаемая дата вызова курьера

desired_time

Обязательный параметр
Желаемое время вызова курьера (09:00 — 12:00, 12:00 — 15:00, 15:00 — 18:00)

notes

Обязательный параметр
Примечания. Рекомендуется передавать детальное описание (характер груза, количество мест). Форма заполнения произвольная, так как сотрудники Exline будут дополнять изменять ее в процессе.
https://api.exline.systems/client/v1/waybills/new
ПараметрЗначение
sender_titleЛучший магазин на свете
sender_phone+7 (774) 340 30 30
origin_region_id1
origin_addressул. Абая, 76А
desired_date2016-03-15
desired_time09:00 – 12:00
notesЭкспресс, посылки, 2 места, уточнить по телефону
{"order":
  { 
    "id":"12345",
    "created_at"::"2016.03.14 10:35 UTC",
    "desired_date":"2016.03.15",
    "desired_time":"09:00 – 12:00",
    "origin_region_id":1,
    "origin_region_title":"Алматы",
    "origin_address":"ул. Абая, 76А",
    "sender_title":"Лучший магазин на свете",
    "sender_phone":"+7 (774) 340 30 30",
    "notes":"Экспресс, посылки, 2 места, уточнить по телефону"
  }
}

created_at – Время создания накладной

desired_date – Желаемая дата сбора

desired_time – Желаемое время сбора

origin_region_id – ID региона отправки

origin_region_title – Наименование региона отправки

origin_address – Адрес отправки

sender_title – Наименование отправителя

sender_phone – Телефон отправителя

notes – Примечания

Регистрация электронной накладной

Для создания электронной накладной заявка не требуется! Система сформирует заявку автоматически.

https://api.exline.systems/client/v1/waybills/new

API вернет номер созданной накладной со статусом 204. В случае, если данные не валидны будет возврашен статус 422. Созданная накладная будет являться черновой (draft: true). В этот момент ее можно исправить (см. https://api.exline.systems/client/v1/waybills/:id/edit) или подтвердить правильность и передать в работу (см. https://api.exline.systems/client/v1/waybills/:id/confirm).

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

ref_number

Дополнительный номер накладной. Указывайте, если ведете свою нумерацию, чтобы потом можно было производить поиск накладной по ref_number, а не по code.

sender_title

Обязательный параметр
Наименование отправителя

sender_phone

Обязательный параметр
Телефон отправителя

origin_region_id

Обязательный параметр
ID региона отправки. Получить список регионов можно в публичном API.

origin_address

Обязательный параметр
Адрес отправки

receiver_title

Обязательный параметр
Наименование получателя

receiver_phone

Обязательный параметр
Телефон получателя

receiver_region_id

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

destination_address

Обязательный параметр
Адрес доставки

service

Обязательный параметр
Услуга. express_mail – Экспресс пакеты, express_parcels – Экспресс посылки, standard_parcels Стандарт посылки

parcels

Обязательный параметр
Массив отправлений по накладной. Требуется хотя бы одно отправление с указанием веса. Передать можно следующие параметры: {weight: вес, h: высота, l: длина, w: ширина}
https://api.exline.systems/client/v1/waybills/new
ПараметрЗначение
ref_number123456
sender_titleЛучший магазин на свете
sender_phone+7 (774) 340 30 30
origin_region_id1
origin_addressул. Абая, 76А
receiver_titleЛучший покупатель
receiver_phone+7 (777) 777 12 34
destination_region_id3
destination_addressпр. Орынбор, 12, офис 7
serviceexpress_parcels
notesТелефон получателя доступен только до 18:00
parcels[{weight: 0.7}, {weight: 0.5, h: 20, w: 20, l: 40}]
{"waybill":
  { 
    "id":"1133440",
    "code":"1932N43110",
    "ref_number":"123456",
    "draft":true,
    "delivered":false,
    "created_at"::"2016.02.17 10:35 UTC",
    "collected_at":null,
    "expire_date":"2016.02.19",
    "origin_region_id":1,
    "origin_region_title":"Алматы",
    "origin_address":"ул. Абая, 76А",
    "destination_region_id":3,
    "destination_region_title":"Астана",
    "destination_address":"пр. Орынбор, 12, офис 7",
    "payment_method":"bank",
    "pricing_policy":"1600 с топливной надбавкой и с минимальной объявленной ценностью 2015",
    "price":3300,
    "declared_value":15000,
    "declared_value_fee":120,
    "fuel_surplus":330,
    "additional_services_price":0,
    "sender_title":"Лучший магазин на свете",
    "sender_phone":"+7 (774) 340 30 30",
    "receiver_title":"Лучший покупатель",
    "receiver_phone":"+7 (777) 777 12 34",
    "service":"express_mail",
    "service_translate":"Экспресс посылки",
    "qty":2,
    "total_weight":3.0,
    "notes":"Телефон получателя доступен только до 18:00"
  }
}

code – Номер накладной

ref_number – Дополнительный номер (номер клиента)

draft – Черновой вариант/В работе. Любая созданная накладная через API имеет draft: true.

delivered – Доставлено/Не доставлено

ref_number – Дополнительный номер (номер клиента)

created_at – Время создания накладной

collected_at – Время сбора отправлений курьером

expire_date – Крайняя дата доставки

origin_region_id – ID региона отправки

origin_region_title – Наименование региона отправки

origin_address – Адрес отправки

destination_region_id – ID региона доставки

destination_region_title – Наименование региона доставки

destination_address – Адрес доставки

payment_method – Способ оплаты. cash – наличными, bank – банковский перевод, electronic – платежные терминалы и карты

pricing_policy – Тарифная сетка

price – Основной тариф

declared_value – Объявленная ценность

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

fuel_surplus – Топливный сбор

additional_services_price – Стоимость дополнительных услуг

sender_title – Наименование отправителя

sender_phone – Телефон отправителя

receiver_title – Наименование получателя

receiver_phone – Телефон получателя

service – Код услуги

service_translate – Перевод кода услуги

qty – Количество отправлений

total_weight – Общий вес (округленный для расчета)

notes – Примечания