Добавить задачи в рейс
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Добавьте задачи заказов в рейс и задайте порядок погрузки и выгрузки. В data.tasks[].taskId передавайте transferOrderTaskID из карточки заказа. Сохраните идентификаторы задач рейса из data.ids.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
POST
https://partner-test-yamagistrali.ru/api/flights/tasks/addBulk/v1
Тестовый стенд
Body
application/json
{
"data": {
"tasks": [
{
"externalId": "example",
"flightId": "example",
"loadingOrder": 0,
"taskId": "example",
"unloadingOrder": 0
}
]
}
}
|
Name |
Description |
|
data |
Type: FlightTasksAddBulkV1Request Example
|
FlightTasksAddBulkV1FlightTask
|
Name |
Description |
|
externalId |
Type: string Example: |
|
flightId |
Type: string Example: |
|
loadingOrder |
Type: integer |
|
taskId |
Type: string Example: |
|
unloadingOrder |
Type: integer |
Example
{
"externalId": "example",
"flightId": "example",
"loadingOrder": 0,
"taskId": "example",
"unloadingOrder": 0
}
FlightTasksAddBulkV1Request
|
Name |
Description |
|
tasks |
Type: FlightTasksAddBulkV1FlightTask[] | null Example
|
Example
{
"tasks": [
{
"externalId": "example",
"flightId": "example",
"loadingOrder": 0,
"taskId": "example",
"unloadingOrder": 0
}
]
}
Responses
200 OK
OK
Body
application/json
{
"data": {
"ids": [
"example"
]
}
}
|
Name |
Description |
|
data |
Type: FlightTasksAddBulkV1Response Example
|
FlightTasksAddBulkV1Response
|
Name |
Description |
|
ids |
Type: string[] | null Example
|
Example
{
"ids": [
"example"
]
}
400 Bad Request
Bad Request
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
Error
|
Name |
Description |
|
info |
Type: object Example
|
|
message |
Type: string Example: |
|
message_code |
Type: string Example: |
Example
{
"info": {},
"message": "example",
"message_code": "example"
}
403 Forbidden
Forbidden
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|