Создание новой заявки в статусе “неактивные”.
Команда voyages/create
Метод POST
Пример запроса
https://api.logist-pro.su/api/voyages/create
[ { "number":"voyage_number", "shipper_code":1, "edit":false, "carcase":{ "code":"D115", "weight_code":"1_5", "type_code":"lesovoz" }, "points":[ { "point_code":"point_1", "address":"Адрес точки погрузки" "point_type":"load", "point_date":"2021-01-01 12:00:00" },{ "point_code":"point_2", "address":"Адрес точки выгрузки" "point_type":"unload", "point_date":"2021-01-03 13:00:00" } ]} ]
Пример ответа
Успешный запрос: { "status": "success", "errors": [], "updates": [], "voyages": { "0.voyage": [ { "number": "voyage_number", "message": [ "success" ] } ] } } Ошибка: { "status": "failed", "errors": { "0.number": [ "already_exists" ] }, "updates": [], "voyages": { "0.voyage": [ { "number": "voyage_number", "message": [ "already_exists" ] } ] } } Обновление: { "status": "success", "errors": [], "updates": { "0.voyage": true }, "voyages": { "0.voyage": [ { "number": "voyage_number", "message": [ "success" ] } ] } }
Поля в запросе | Обязательное поле | Описание | Тип поля | Пример\комментарий |
---|---|---|---|---|
number | обязательно | Номер рейса | string (1..100) | Уникальный код рейса |
shipper_code | обязательно | Значение кода (ID) грузоотправителя | numeric | Предоставляется после регистрации |
edit | обязательно | Значение для редактирование рейса | boolean | Если true - то обновляет поля рейса и точек, false - создается новый рейс |
carcase | транспортное средство | array[] | ||
carcase.code | обязательно | Код Тип ТС | string (1..255) | |
carcase.weight_code | обязательно при создании нового ТС | Код грузоподъемности | string (1..255) | Типы описаны в справочнике |
carcase.type_code | обязательно при создании нового ТС | Код типа подвижного состава | string (1..255) | Типы описаны в справочнике |
points | точки маршрута | array[] | ||
points.point_code | обязательно | Уникальный код точки | string (1..255) | |
points.address | обязательно при создании новой точки | Адрес точки | string (1..255) | |
points.point_type | обязательно | Тип точки (загрузка\выгрузка) | string (1..255) | load / unload / extra_load / extra_unload |
points.point_date | обязательно | Дата\время прибытия на точку | string (19) | Формат: “2021-01-01 12:00:00” |
Поля в ответе | Описание | Тип поля | Пример\комментарий |
---|---|---|---|
status | Статус запроса | string (1..100) | success/failed |
errors | Блок ошибок | array() | |
errors.0.number | номер рейса, поле с ошибкой и описание ошибки | array() | 0 - номер рейса в запросе, number - поле с ошибкой |
updates | Блок обновления рейса | array() | |
updates.0.voyage | номер и статус обновления рейса | array() | |
voyages | Блок статусов по каждому рейсу с его номером | array() |