Создание/обновление пропуска на одну или несколько отгрузок

POST /v1/shipment/pass/update

POST/v1/shipment/pass/update

Допустимые статусы отгрузки: DRAFT, READY, IN_TRANSIT.

Тело запроса

shipment_ids
array
required
Идентификаторы отгрузок, на которые оформляется один пропуск (несколько отгрузок в одной машине).
vehicle
object
required
Данные о машине для пропуска.
Показать свойства
driver_name
string
required
ФИО водителя.
driver_phone
string
required
Номер телефона водителя.
vehicle_model
string
required
Модель авто.
vehicle_plate
string
required
Госномер авто.
idempotency_key
string
required
Ключ идемпотентности запроса создания/обновления пропуска.

Успешный ответ

200A successful response.
application/json
object
Свойства не описаны

Ошибки

400Некорректный запрос
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
401Ошибка авторизации
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
429Превышен лимит запросов
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string
код ошибки
message
string
сообщение
details
object
POST/v1/shipment/pass/update
1curl https://api.omninet.ru/v1/shipment/pass/update \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "shipment_ids": [6    "string"7  ],8  "vehicle": {9    "driver_name": "string",10    "driver_phone": "string",11    "vehicle_model": "string",12    "vehicle_plate": "string"13  },14  "idempotency_key": "string"15}'
{}

A successful response.