Рус
Рус
Присоединяйтесь к нам в социальных сетях
API предзаявок
В запросах обязательно указывается заголовок:
Accept: application/json Клиентский API предоставляет возможность создать в нашей системе предварительный заказ.
Предварительный заказ - создание
POST https://cabinet-api.exline.kz/api/client/v1/preorders?secret=xxxxxxxxxxxxxxx В теле запроса необходимо передать json объект preorder с набором параметров:
sender: Наименование отправителя (string), max: 255
origin_region: Код КАТО или наименование города сбора (string), max: 255. Обязателен, если отсутствует параметр origin_region_id. Код КАТО или наименование региона должны совпадать с данными в справочнике "API населенных пунктов". Код КАТО задан не у всех регионов. Вместо этого параметра рекомендуется использовать origin_region_id, для более точного определения региона.
origin_region_id: Идентификатор города сбора (int), обязателен, если отсутствует параметр origin_region. Идентификатор региона можно получить из справочника "API населенных пунктов".
origin_address: Адрес сбора (string), max: 255
receiver: Наименование получателя (string), max: 255
destination_region: Код КАТО или наименование города доставки (string), max: 255. Обязателен, если отсутствует параметр destination_region_id. Код КАТО или наименование региона должны совпадать с данными в справочнике "API населенных пунктов". Код КАТО задан не у всех регионов. Вместо этого параметра рекомендуется использовать destination_region_id, для более точного определения региона.
destination_region_id: Идентификатор города доставки (int), обязателен, если отсутствует параметр origin_region. Идентификатор региона можно получить из справочника "API населенных пунктов"
destination_address: Адрес доставки (string), max: 255
customer_iin: ИИН или БИН плательщика, только цифры, min:6, max:14. Плательщик с указанным номером должен быть зарегистрирован у нас в системе.
client_code: Номер заказа в вашей системе, он записывается в отдельное поле в нашей системе, на основе него генерируется номер накладной. (string), max: 255
weight: Вес, кг (float)
receiver_phone: Контактный телефон получателя (string), max: 255
price: Необязательное поле. Цена товара, на основе которого вычисляется оценочная стоимость (float), если указан, должен быть больше 0.
service: Необязательное поле. Доступные варианты: 'standard', 'express_mail', 'express_parcels'
comment: Необязательное поле. Комментарий для накладной (string), max: 255
sender_phone: Контактный телефон отправителя (string), max: 255
note: Необязательное поле. Примечание для заявки. Например описание вложимого товара (string), max: 255
quantity: Необязательное поле. Количество (int)
desire_date: Необязательное поле. Ориентировочная дата сбора (date), пример: "2018 -05-30"
parcels: Необязательное поле. Список отправлений (array)
Пример запроса:
https://cabinet-api.exline.kz/api/client/v1/preorders?secret=123456 Внутри json объект:
{
"preorder":
{
"sender": "John Doe",
"origin_region": "750000000",
"origin_address": "Main St, 123",
"sender_phone": "+7 (777) 1234567",
"receiver": "Jane Doe",
"destination_region": "591010000",
"destination_address": "Second Ave, 345",
"weight": 1.3,
"client_code": "YOUR_ORDER_NUMBER",
"customer_iin": "123456789012",
"receiver_phone": "+7 (777) 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".
Пример:
{
"error": {
"client_code": "Указанный client_code уже существует."
}
}
Предварительный заказ - отмена
Если вы отмените предварительную заявку, то вместе с ней отменяется и заявка, созданная на ее основе. Нельзя отменить предварительную заявку, если у ее заявки статус "Отправления собраны" или "Заявка закрыта".
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"
}
}
Ошибки
Все ошибки возвращаются с ключом "error".
Пример:
{
"error": "Предварительная заявка уже была отменена."
}
ExLine — линия надежной доставки!
