Присоединяйтесь к нам в социальных сетях

API заявок

Взаимодействие с API происходит только по защищенному HTTPS соединению.

Все ошибки API возвращаются с соответствующим HTTP статусом и описанием ошибки в виде JSON вида {"errors": ...}. Например при неправильных данных аутентификации будет возвращен статус 401 с ответом {"errors": "wrong credentials"}.

Все запросы содержащие body должны передавать данные в виде JSON объекта как application/json

Минимальный набор необходимых заголовков:

KeyValue
Acceptapplication/json
Content-Typeapplication/json

Создание заявки

POST https://cabinet-api.exline.kz/api/client/v1/orders?secret=xxx BODY SCHEMA
{
  "sender_iin_bin": {String} required, format: [0-9]{12},
  "payer_iin_bin": {String} required, format: [0-9]{12},
  "payment_method": {String} required, format: electronic|bank,
  "pickup_address": {
    "region_id": {Int} required, // API населенных пунктов, https://exline.kz/docs/regions
    "street": {String} required,
    "home": {String} required,
    "apartment": {String}, optional,
    "floor": {String}, optional
  },
  "quantity": {Int} required, min: 1, max: 100,
  "contact_person": {String}, required,
  "contact_person_phone": {String} required,
  "pickup_date": {String} required,
  "note": {String} optional,
}
BODY EXAMPLE
{
  "sender_iin_bin": "999999999999",
  "payer_iin_bin": "999999999999",
  "payment_method": "bank",
  "pickup_address": {
      "region_id": 4,
      "street": "Назарбаева",
      "home": "187Б",
      "apartment": "",
      "floor": "6"
  },
  "quantity": 1,
  "contact_person": "John Doe",
  "contact_person_phone": "+77777777777",
  "pickup_date": "2025-01-08",
  "note": "Стандарт-посылки, Газель"
}
RESPONSE 200
{
  "id": 1415,
  "payer": "ТОО Тест",
  "sender": "ТОО Тест",
  "pickup_address": {
    "region": "Алматы",
    "street": "Назарбаева",
    "home": "187Б",
    "apartment": null,
    "floor": "6",
    "full_address": "Казахстан, Алматы, ул. Назарбаева, д. 187Б, эт. 6"
  },
  "status": "Не распределена",
  "pickup_date": "2025-01-09",
  "pickup_time": "В течение дня",
  "contact_person": "John Doe",
  "contact_person_phone": "77777777777",
  "payment_method": "Безнал",
  "note": "Количество мест - 1, Стандарт-посылки, Газель"
}

Пример в случае предоставления невалидных данных

RESPONSE 422
{
  "message": "Поле sender iin bin не может быть пустым (and 1 more error)",
  "errors": {
    "sender_iin_bin": [
      "Поле sender iin bin не может быть пустым"
    ],
    "quantity": [
      "Поле quantity должно быть больше 1"
    ]
  }
}

Получение информации о заявке

GET https://cabinet-api.exline.kz/api/client/v1/orders/{id}?secret=xxxRESPONSE 200
{
  "id": 1415,
  "payer": "ТОО Тест",
  "sender": "ТОО Тест",
  "pickup_address": {
    "region": "Алматы",
    "street": "Назарбаева",
    "home": "187Б",
    "apartment": null,
    "floor": "6",
    "full_address": "Казахстан, Алматы, ул. Назарбаева, д. 187Б, эт. 6"
  },
  "status": "Не распределена",
  "pickup_date": "2025-01-09",
  "pickup_time": "В течение дня",
  "contact_person": "John Doe",
  "contact_person_phone": "77777777777",
  "payment_method": "Безнал",
  "note": "Количество мест - 1, Стандарт-посылки, Газель"
}