Добавить задачи в рейс

Порядок работы для агента · Методы 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
{
  "tasks": [
    {
      "externalId": "example",
      "flightId": "example",
      "loadingOrder": 0,
      "taskId": "example",
      "unloadingOrder": 0
    }
  ]
}

FlightTasksAddBulkV1FlightTask

Name

Description

externalId

Type: string

Example: example

flightId

Type: string

Example: example

loadingOrder

Type: integer

taskId

Type: string

Example: example

unloadingOrder

Type: integer

Example
{
  "externalId": "example",
  "flightId": "example",
  "loadingOrder": 0,
  "taskId": "example",
  "unloadingOrder": 0
}

FlightTasksAddBulkV1Request

Name

Description

tasks

Type: FlightTasksAddBulkV1FlightTask[] | null

Example
[
  {
    "externalId": "example",
    "flightId": "example",
    "loadingOrder": 0,
    "taskId": "example",
    "unloadingOrder": 0
  }
]
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
{
  "ids": [
    "example"
  ]
}

FlightTasksAddBulkV1Response

Name

Description

ids

Type: string[] | null

Example
[
  "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
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

Error

Name

Description

info

Type: object

Example
{}

message

Type: string

Example: example

message_code

Type: string

Example: 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
{
  "info": {},
  "message": "example",
  "message_code": "example"
}

500 Internal Server Error

Internal Server Error

Body

application/json
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}

Name

Description

error

Type: Error

Example
{
  "info": {},
  "message": "example",
  "message_code": "example"
}