Редактирование LTL накладной

Данный эндпоинт позволяет редактировать информацию в существующей LTL накладной. Вы должны указать данные отправителя, получателя, параметры груза, а также дополнительные услуги.

Метод запроса: PUT

https://gateway.spark-dev.team/cabinet/api/client/invoice/<invoice_number>

Описание параметров запроса:

Наименование параметра	Тип	Обязательный параметр	Описание
sender	Объект Sender	Да	Отправитель
additional_service	Объект AdditionalService	Да	Доп.услуги
receiver	Объект Receiver	Да	Получатель
dop_invoice_number	String	Нет	№ Накладной заказчика
product_name	String	Нет	Наименование товара
product_category	String	Нет	Категория товара
track_number	String	Нет	Трек номер
height	Number	Да	Высота, сантиметр (см)
width	Number	Да	Ширина, сантиметр (см)
weight	Number	Да	Вес, килограмм (кг)
volume	Number	Да	Объём, метр куб (м3)
depth	Number	Да	Глубина, сантиметр (см)
period_id	Number	Да	Период забора 1 - До обеда (8:00 - 12:00) 2 - После обеда (12:00 - 18:00) 3 - Полный день (9:00 - 18:00)
shipment_type	Number	Да	Транспорт доставки 1 - Авто 2 - Авиа
payment_method	Number	Да	Способ оплаты 2 - Наличными 3 - Перечислением 4 - Kaspi Pay
payment_type	Number	Да	Кто оплачивает 1 - Отправитель 2 - Получатель
take_date	String	Да	Дата забора
should_return_document	Number	Да	Возвратные документы 1 - Да 2 - Нет
places	Number	Да	Количество мест
declared_price	Number	Нет	Объявленная стоимость
verify	Number	Нет	Верификация
annotation	String	Нет	Примечание
cod_payment	String	Нет	Наложенный платёж

Объект Sender

Описание параметров объекта - Отправителя:

Наименование параметра	Тип	Обязательный параметр	Описание
title	String	Да	Заголовок
city_id	Number	Да	ID города
phone	String	Да	Номер телефона
self_delivery	Number	Нет	Самопривоз 0 - Нет, 1 - Да
street	String	Да, если self_delivery пустой	Улица
house	String	Да, если self_delivery пустой	Дом
latitude	String	Нет	Широта
longitude	String	Нет	Долгота
office	String	Нет	Квартира / Офис
full_name	String	Да	Ф.И.О
full_address	String	Да, если self_delivery пустой	Полный адрес
index	String	Нет	Индекс
comment	String	Нет	Комментарий

Пример объекта:

{
    "title": "Новый отправитель",
    "city_id": 1,
    "phone": "+77083039131",
    "self_delivery": 1,
    "street": "Толе би",
    "house": "101",
    "office": "5",
    "full_name": "Иванов Иван Иванович",
    "full_address": "Казахстан, г. Алматы, ул. Толе би, 101",
    "index": "111",
    "comment": "Отправки раз в месяц"
}

Объект AdditionalService

Описание параметров объекта - Дополнительных услуг:

Наименование параметра	Тип	Обязательный параметр	Описание
hasSoftPackage	Boolean	Нет	Мягкая упаковка
hasManipulator	Boolean	Нет	Манипулятор
hasCrane	Boolean	Нет	Кран
hasHydraulicTrolley	Boolean	Нет	Рохля
hasGrid	Boolean	Нет	Обрешетка
hasLoader	Boolean	Нет	Грузчики

Пример объекта:

{
    "hasSoftPackage": true,
    "hasManipulator": false,
    "hasCrane": false,
    "hasHydraulicTrolley": false,
    "hasGrid": true,
    "hasLoader": false
}

Объект Receiver

Описание параметров объекта - Получателя:

Наименование параметра	Тип	Обязательный параметр	Описание
pvz_id	Number	Нет	Пункт ПВЗ
title	String	Нет	Заголовок
city_id	Number	Нет	ID города
phone	String	Нет	Номер телефона
self_delivery	Number	Нет	Самовывоз 0 - Нет, 1 - Да
street	String	Нет	Улица
house	String	Нет	Дом
latitude	String	Нет	Широта
longitude	String	Нет	Долгота
office	String	Нет	Квартира / Офис
full_name	String	Нет	Ф.И.О
full_address	String	Нет	Полный адрес
index	String	Нет	Индекс
comment	String	Нет	Комментарий

Пример объекта:

{
    "title": "Новый получатель",
    "city_id": 2,
    "phone": "+77083039131",
    "self_delivery": 1,
    "street": "Толе би",
    "house": "101",
    "office": "5",
    "full_name": "Иванов Иван Иванович",
    "full_address": "Казахстан, г. Алматы, ул. Толе би, 101",
    "index": "111",
    "comment": "Отправки раз в месяц"
}

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

{
    "sender": {
        "title": "Новый отправитель",
        "city_id": 1,
        "phone": "+77083039131",
        "self_delivery": 1,
        "street": "Толе би",
        "house": "101",
        "office": "5",
        "full_name": "Иванов Иван Иванович",
        "full_address": "Казахстан, г. Алматы, ул. Толе би, 101",
        "index": "111",
        "comment": "Отправки раз в месяц"
    },
    "additional_service": {
        "hasSoftPackage": true,
        "hasManipulator": false,
        "hasCrane": false,
        "hasHydraulicTrolley": false,
        "hasGrid": true,
        "hasLoader": false
    },
    "receiver": {
        "title": "Новый получатель",
        "city_id": 2,
        "phone": "+77083039131",
        "self_delivery": 1,
        "street": "Толе би",
        "house": "101",
        "office": "5",
        "full_name": "Иванов Иван Иванович",
        "full_address": "Казахстан, г. Алматы, ул. Толе би, 101",
        "index": "111",
        "comment": "Отправки раз в месяц"
    },
    "height": 1,
    "width": 1,
    "depth": 2,
    "volume": 2,
    "weight": 2,
    "period_id": 1,
    "shipment_type": 1,
    "payment_method": 2,
    "payment_type": 1,
    "take_date": "2022-05-12",
    "should_return_document": 1,
    "places": 10
}

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

{
    "data": null,
    "code": 0,
    "success": true,
    "message": "Данные успешно обновлены!",
    "errors": []
}