Оформление отправки в модуль логистики

Для оформления новой отправки, надо отправить POST запрос с типом содержимым application/x-www-form-urlencoded или application/json

POST

/_api/v1/shipments

Параметры метода

Метод принимает следующие параметры:

Наименование

Обязательно

Описание

town_from

Да

Название города, из которого осуществляется доставка

delivery_from_address

Нет

Адрес, откуда следует осуществить забор груза

sender_phone_number

Нет

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

town_to

Да

Название города, куда осуществляется доставка

delivery_address

Да

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

total_weight

Да

Вес отправления

dimensions

Нет

Размеры груза.

Следует передавать сюда Map со следующими ключами:

length – длина

width – ширина

height – высота

recipient

Да

ФИО получателя

recipient_phone_number

Да

Номер телефона получателя

comment

Нет

Комментарий

items

Нет

Список позиций к отправке (пакинг лист)

title

Нет

Наименование отправки. Может быть любой строкой

items

Список позиций к отправке

Элемент

Обязательно

Описание

title

Да

Наименование позиции

weight

Да

Вес позиции

barcode

Нет

Штрихкод позиции

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

Пример запроса в формате application/x-www-form-urlencoded (без urlencode)

town_from=Владивосток&delivery_from_address=Выселковая, 9

Пример запроса в формате application/json

{
    "town_from": "Владивосток",
    "delivery_from_address": "Выселковая, 9",
    ...
}

Пример ответа

В случае успешного выполнение запроса, будет возвращен json ответ вида:

{
    "item": {
        "id": 123
    }
}

Где вместо 123 будет уникальный идентификатор отправки.

В случае ошибки будет возвращена структура вида:

{
    "error": {
        "message": "Ошибка данных",
        "fields_errors": {
            // описание ошибок с полями
        }
    }
}