API предзаявок

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

Accept: application/json

Клиентский API предоставляет возможность создать в нашей системе предварительный заказ.

Предварительный заказ - создание

POST https://cabinet-api.exline.kz/api/client/v1/preorders?secret=xxxxxxxxxxxxxxx

В теле запроса необходимо передать json объект preorder с набором параметров:

sender: Наименование отправителя (string)
origin_region: Код КАТО или наименование города сбора (string)
origin_region_id: Идентификатор города сбора (int)
origin_address: Адрес сбора (string)
receiver: Наименование получателя (string)
destination_region: Код КАТО или наименование города доставки (string)
destination_region_id: Идентификатор города доставки (int)
destination_address: Адрес доставки (string)
customer_iin: ИИН или БИН плательщика (string)
client_code: Номер заказа в вашей системе, он записывается в отдельное поле в нашей системе, на основе него генерируется номер накладной. Также производить поиск накладной можно будет как по ref_number так и по номеру накладной (string)
weight: Вес(кг) (float)
receiver_phone: Контактный телефон получателя (string)
price: Необязательное поле. Цена товара, на основе которого вычисляется оценочная стоимость (integer)
service: Необязательное поле. Доступные варианты: 'standard' или 'express' (string)
comment: Необязательное поле. Комментарий (string)
sender_phone: Контактный телефон отправителя (string)
note: Необязательное поле. Например описание вложимого товара (string)
quantity: Необязательное поле. Количество (integer)
desire_date: Необязательное поле. Ориентировочная дата сбора (string), пример: "2018 -05-30"
parcels: Необязательное поле. Список отправлений (array)

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

https://cabinet-api.exline.kz/api/client/v1/preorders?secret=123456

Внутри json объект:

{
  "preorder":
  {
    "sender":"Иванов Иван",
    "origin_region":"750000000",
    "origin_address":"Абая 153",
    "sender_phone":"+7(121)1234567",
    "receiver":"Петров Петр",
    "destination_region":"591010000",
    "destination_address":"Бокейханова 17",
    "weight":1.3,
    "client_code":"YOUR_ORDER_NUMBER",
    "customer_iin":"123456789012",
    "receiver_phone":"+7(121)1234567, +7 (727) 123-45-67",
    "comment":"Комментарий",
    "note":"Iphone X; Телефон",
    "quantity":2,
    "price": 400000,
    "desire_date":"2018-05-30",
    "parcels": [
      {
        "code": "2400042220776",
        "weight": "0.3"
      }
    ]
  }
}

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

{
  "preorder": {
    "id": 20,
    "waybill_name": "950562018985",
    "created_at": "2018-02-02T03:20:05.459Z",
    "link_to_pdf": "https://cabinet-api.exline.kz/storage/api/950562018985.pdf"
  }
}

Ошибки

Ниже приведен список ошибок при попытке создания предварительной заявки. Все ошибки передаются в объекте error.

1. "error": "Wrong credentials (secret)" - неправильный secret или его отсутствие
2. "error": "The :key must be a string.", "The :key field is required." - валидация параметров, указывается параметр и тип невалидности
3. "error": "origin_region_uniquness_violation" - найдено более 1 населенного пункта по коду КАТО.
4. "error": "destination_region_uniquness_violation" - найдено более 1 населенного пункта по коду КАТО.
5. "error": "origin_region_not_found" - не найдено ни одного населленного пункта по коду КАТО.
6. "error": "destination_region_not_found" - не найдено ни одного населленного пункта по коду КАТО.
7. "error": "customer_not_found" - плательщик с переданным ИИН или БИН не найден
8. "error": "service_not_found" - если услуга передана, но такой услуги не существует
9. "error": "duplication_client_code_error" - предварительная заявка с таким номером уже существует в нашей системе

Предварительный заказ - отмена

POST https://cabinet-api.exline.kz/api/client/v1/preorders/decline?secret=xxxxxxxxxxxxxxx

В теле запроса необходимо передать json объект preorder с набором параметров:

client_code: Номер заказа, по которому будет произведен поиск (string)

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

https://cabinet-api.exline.kz/api/client/v1/preorders/decline?secret=123456

Внутри json объект:

{
  "preorder":
  {
    "client_code":"YOUR_ORDER_NUMBER"
  }
}

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

{
  "preorder": {
    "id": 9,
    "created_at": "2018-01-26T09:13:38.194Z",
    "declined_at": "2018-01-29T06:53:56.300Z"
   }
}

Ошибки

1. "error": "preorder_not_found" - не найден предварительный заказ с таким номером клиента
2. "error": "preorder_already_completed" - предварительный заказ найден, но на основе него уже создана накладная. Сотрудники будут уведомлены, что данный заказ требуется вернуть отправителю. Статус предварительной заявки останется completed
3. "error": "preorder_already_declined" - предварительный заказ найден, и уже имеет статус отменен

Услуги

Рассчитать стоимость

Вызвать курьера

Отследить посылку

Обратный звонок

ExLine — линия надежной доставки!

Навигация по сайту

Отследить посылку Контроль качества Рассчитать стоимость Вызвать курьера Обратный звонок О компании Документация API

Тарифы и услуги

Экспресс доставка Стандартная доставка Международная доставка Внутригородская доставка Дополнительные услуги Сроки доставки Классификатор зон

Контакты

+7 (777) 755 57 25 +7 (777) 755 50 57 almaty@exline.kz

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

Правовая информация

Договор оферты