Перейти к содержанию

Редактирование заявки по грузу

Описание

С помощью этого метода можно отредактировать заявку по грузу.

Структура URL

1
PUT /v2/proposals/my/cargo/{status}/{id}

Список параметров

Название Описание Тип передачи параметра Обязат.(+)/По умолч.(значение)
status Перечисление "Статусы заявки". Path parameter +
id Идентификатор заявки. Path parameter +
publishDate Дата публикации заявки, timestamp. Если параметр status не будет иметь значения "prepared", значение publishDate будет проигнорировано. Query string parameter
contactId Идентификатор подчиненного контакта пользователя. Query string parameter
dateFrom Дата загрузки, "yyyy-MM-dd". Query string parameter
dateTo Дата выгрузки, "yyyy-MM-dd". Query string parameter
paymentPrice Цена доставки. Query string parameter
paymentCurrencyId Идентификатор валюты из Справочника. Query string parameter
paymentUnitId Идентификатор единицы оплаты из Справочника. Query string parameter
paymentTypeId Идентификатор типа оплаты из Справочника. Query string parameter
paymentMomentId Идентификатор момента оплаты из Справочника. Query string parameter
paymentPrepay Процент предоплаты от общей стоимости. Query string parameter
paymentDelay Отсрочка платежа, дни. Query string parameter
paymentVat Наличие НДС. Query string parameter
bodyTypeId Идентификатор типа транспортного средства из Справочника. Query string parameter
bodyGroupId Идентификатор группы типов транспортного средства из Справочника. Query string parameter
refrigeratorRegime Наличие температурного режима. Query string parameter
refrigeratorRegimeFrom Нижняя граница температурного режима. Query string parameter
refrigeratorRegimeTo Верхняя граница температурного режима. Query string parameter
loadTypes Массив идентификаторов типов загрузки из Справочника. Query string parameter
unloadTypes Массив идентификаторов типов выгрузки из Справочника. Query string parameter
adr Класс ADR. Query string parameter
cmr Наличие транспортной накладной CMR. Query string parameter
cmrInsurance Наличие страхового полиса CMR. Query string parameter
groupage Возможность догруза. Query string parameter
t1 Наличие документа таможенного транзита T1. Query string parameter
tir Наличие документа таможенного транзита TIR. Query string parameter
lorryAmount Необходимое количество транспорта. Query string parameter
note Примечание. Query string parameter
contentName Произвольное название груза. Используйте этот параметр, если не можете определить или получить contentId. Один из двух параметров: contentName, contentId - должен быть указан. Query string parameter
contentId Наименование груза из Справочника. Один из двух параметров: contentName, contentId - должен быть указан. Query string parameter
medicalRecords Наличие медицинской книжки. Query string parameter
customsControl Находится ли груз под таможенным контролем. Query string parameter
loadingFrequencyId Идентификатор частоты отгрузки из Справочника. Query string parameter
sizeMassFrom Нижняя граница массы груза, т. Один из двух параметров: sizeMassFrom, sizeMassTo - должен быть указан. Query string parameter
sizeMassTo Верхняя граница массы груза, т. Один из двух параметров: sizeMassFrom, sizeMassTo - должен быть указан. Query string parameter
sizeVolumeFrom Нижняя граница объема груза, м3. Query string parameter
sizeVolumeTo Верхняя граница объема груза, м3. Query string parameter
sizeLength Длина груза, м. Query string parameter
sizeWidth Ширина груза, м. Query string parameter
sizeHeight Высота груза, м. Query string parameter
waypointListSource Точки загрузки, массив Структур "Точка загрузки в запросах". Request body parameter
waypointListTarget Точки выгрузки, массив Структур "Точка загрузки в запросах". Request body parameter

Примечания:

  • Если не нужно изменять какой-либо параметр заявки, не включайте его в запрос;
  • Если нужно очистить числовое значение, передайте 0 в качестве значения параметра;
  • Если нужно очистить строковое значение или массив (например loadTypes), передайте этот параметр с пустой строкой в качестве значения (например, &note=&loadTypes=).

Результаты

Успешный результат

Структура "Успешный результат редактирования заявки".

Результаты с ошибками

Ошибка валидации

Структура "Ошибка валидации заявки".

Ошибка с кодом

Структура "Ошибка с кодом"

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

BASH
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
curl -X PUT -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: 3WQ1EQ465C4005000130" \
"https://api.lardi-trans.com/v2/proposals/my/cargo/published/350203659?\
loadTypes=24,25\
&unloadTypes=\
&note=\
&cmr=false\
&sizeMassFrom=19\
&sizeMassTo=0\
" -d '{
    "waypointListSource": [
        {
            "address": "уточнение адреса",
            "countrySign": "UA",
            "areaId": 23,
            "townId": 137
        }
    ],
    "waypointListTarget": [
        {
            "address": "уточнение адреса",
            "countrySign": "UA",
            "areaId": 34,
            "townId": 69
        }
    ]
}'

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

1
2
3
{
    "result": "OK"
}