Получить изменения рейсов заказчика
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Читайте события с id больше data.lastId. По умолчанию размер порции data.limit равен 100, максимум — 1000. Для одной организации укажите data.forwarderId строкой. Нужны роль заказчика и право flight_view_changes. В записях data.changes поля forwarderId и orderId — массивы, flightId — строка. Храните идентификаторы и полный ответ в клиенте.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
POST
https://partner-test-yamagistrali.ru/api/flights/changesForForwarders/get/v0
Тестовый стенд
Body
application/json
{
"data": {
"forwarderId": "example",
"lastId": 0,
"limit": 0
}
}
|
Name |
Description |
|
data |
Type: FlightsChangesForForwardersGetV0Request Example |
FlightsChangesForForwardersGetV0Request
|
Name |
Description |
|
forwarderId |
Type: string | null Example: |
|
lastId |
Type: integer | null |
|
limit |
Type: integer | null |
Example
{
"forwarderId": "example",
"lastId": 0,
"limit": 0
}
Responses
200 OK
OK
Body
application/json
{
"data": {
"changes": [
{
"flightId": "example",
"forwarderId": [
"example"
],
"id": 0,
"orderId": [
"example"
],
"updatedAt": "2025-07-22T20:21:19.773333823Z"
}
]
}
}
|
Name |
Description |
|
data |
Type: FlightsChangesForForwardersGetV0Response Example |
FlightsChangesForForwardersGetV0Item
|
Name |
Description |
|
flightId |
Type: string Example: |
|
id |
Type: integer |
|
updatedAt |
Type: string Example: |
|
forwarderId |
Type: string[] | null Example |
|
orderId |
Type: string[] | null Example |
Example
{
"flightId": "example",
"forwarderId": [
"example"
],
"id": 0,
"orderId": [
"example"
],
"updatedAt": "2025-07-22T20:21:19.773333823Z"
}
FlightsChangesForForwardersGetV0Response
|
Name |
Description |
|
changes |
Type: FlightsChangesForForwardersGetV0Item[] | null Example |
Example
{
"changes": [
{
"flightId": "example",
"forwarderId": [
"example"
],
"id": 0,
"orderId": [
"example"
],
"updatedAt": "2025-07-22T20:21:19.773333823Z"
}
]
}
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 |