Редактирование заявки по грузу
Описание
С помощью этого метода можно отредактировать заявку по грузу.
Структура URL
PUT /v2/proposals/my/cargo/{status}/{id}
Список параметров
Название | Описание | Тип передачи параметра | Обязат.(+)/По умолч.(значение) |
---|---|---|---|
language |
Язык локализации. Описание использования. | Query string parameter | ru |
status |
Перечисление "Статусы заявки". Статус уточняет идентификатор. Например, если заявка опубликована, то какой-либо другой статус вернет ошибку "Не найдено". | Path parameter | + |
id |
Идентификатор заявки. | Path parameter | + |
publishDate |
Дата публикации заявки, timestamp. Если параметр status не будет иметь значения "prepared" , значение publishDate будет проигнорировано. |
Request body parameter | |
contactId |
Идентификатор подчиненного контакта пользователя. | Request body parameter | |
dateFrom |
Начальная дата загрузки, "yyyy-MM-dd". | Request body parameter | |
dateTo |
Конечная дата загрузки, "yyyy-MM-dd". | Request body parameter | |
paymentValue |
Цена доставки. | Request body parameter | + |
paymentCurrencyId |
Идентификатор валюты из Справочника. | Request body parameter | + |
paymentUnitId |
Идентификатор единицы оплаты из Справочника. | Request body parameter | |
paymentMomentId |
Идентификатор момента оплаты из Справочника. | Request body parameter | |
paymentPrepay |
Процент предоплаты от общей стоимости. | Request body parameter | |
paymentDelay |
Отсрочка платежа, дни. | Request body parameter | |
bodyGroupId |
Идентификатор группы типов транспортного средства из Справочника (устаревшее). | Request body parameter | |
cargoBodyTypeIds |
Массив идентификаторов типов транспортного средства из Справочника. | Request body parameter | |
cargoPackaging[].id |
Идентификатор типа упаковки из Справочника. | Request body parameter | |
cargoPackaging[].count |
Количество упаковки. | Request body parameter | |
paymentForms[].id |
Идентификатор типа оплаты из Справочника. | Request body parameter | |
paymentForms[].vat |
Наличие НДС. | Request body parameter | |
refrigeratorRegime |
Наличие температурного режима. | Request body parameter | |
refrigeratorRegimeFrom |
Нижняя граница температурного режима. | Request body parameter | |
refrigeratorRegimeTo |
Верхняя граница температурного режима. | Request body parameter | |
loadTypes |
Массив идентификаторов типов загрузки из Справочника. | Request body parameter | |
adr |
Класс ADR. | Request body parameter | |
cmr |
Наличие транспортной накладной CMR. | Request body parameter | |
cmrInsurance |
Наличие страхового полиса CMR. | Request body parameter | |
groupage |
Возможность догруза. | Request body parameter | |
t1 |
Наличие документа таможенного транзита T1. | Request body parameter | |
tir |
Наличие документа таможенного транзита TIR. | Request body parameter | |
lorryAmount |
Необходимое количество транспорта. | Request body parameter | |
note |
Примечание. | Request body parameter | |
contentName |
Произвольное название груза. Используйте этот параметр, если не можете определить или получить contentId . Один из двух параметров: contentName , contentId - должен быть указан. |
Request body parameter | |
contentId |
Наименование груза из Справочника. Один из двух параметров: contentName , contentId - должен быть указан. |
Request body parameter | |
medicalRecords |
Наличие медицинской книжки. | Request body parameter | |
customsControl |
Находится ли груз под таможенным контролем. | Request body parameter | |
loadingFrequencyId |
Идентификатор частоты отгрузки из Справочника. | Request body parameter | |
sizeMass |
Масса груза, т. | Request body parameter | + |
sizeVolume |
Объем груза, м3. | Request body parameter | |
sizeLength |
Длина груза, м. | Request body parameter | |
sizeWidth |
Ширина груза, м. | Request body parameter | |
sizeHeight |
Высота груза, м. | Request body parameter | |
waypointListSource |
Точки загрузки, массив Структур "Точка загрузки в запросах". | Request body parameter | |
waypointListTarget |
Точки выгрузки, массив Структур "Точка загрузки в запросах". | Request body parameter | |
cargoBodyTypeProperties |
Характеристики кузова, перечисляемый тип. DOUBLE_DECK, JUMBO, MEGA | Request body parameter |
Примечание:
Если не нужно изменять какой-либо параметр заявки, не включайте его в запрос;
Результаты
Успешный результат
Структура "Успешный результат".
Результаты с ошибками
Ошибка валидации
Структура "Ошибка валидации заявки".
Ошибка с кодом
Пример запроса
BASH
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" \
-d '{
"loadTypes": [
24,
25
],
"paymentForms": [
{
"id": 10,
"vat": true
}
],
"cargoPackaging": [
{
"id": 10,
"count": 12
}
],
"note": "",
"cmr": false,
"sizeMass": 19,
"waypointListSource": [
{
"address": "уточнение адреса",
"countrySign": "UA",
"areaId": 23,
"townId": 137
}
],
"waypointListTarget": [
{
"address": "уточнение адреса",
"countrySign": "UA",
"areaId": 34,
"townId": 69
}
],
"cargoBodyTypeProperties": [
"MEGA", "JUMBO"
]
}'
Пример ответа
{
"result": "OK"
}