Получить рейсы заказчика

Порядок работы для агента · Методы API и схема OpenAPI.

Назначение

Получите актуальные карточки рейсов. Для чтения нужно право view_all_orders. Передайте непустой список идентификаторов в data.ids и найдите записи в data.flights по id. Оставляйте полные карточки с контактами, адресами и другими чувствительными данными в клиенте.

Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде example показывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.

Request

POST

https://partner-test-yamagistrali.ru/api/flights/v1/listForForwarder

Тестовый стенд

Body

application/json
{
  "data": {
    "additionalConditionsExternalOrderID": [
      "example"
    ],
    "carBodyType": [
      "example"
    ],
    "carBrand": [
      "example"
    ],
    "carNumber": [
      "example"
    ],
    "carType": [
      "example"
    ],
    "cargoIds": [
      "example"
    ],
    "customerIds": [
      "example"
    ],
    "distributionComment": [
      "example"
    ],
    "driverIds": [
      "example"
    ],
    "exactIds": [
      "example"
    ],
    "executorIds": [
      "example"
    ],
    "externalExecutor": [
      "example"
    ],
    "filter": {
      "additionalConditionsExternalOrderID": [
        "example"
      ],
      "bodyTypeComments": [
        "example"
      ],
      "carBodyType": [
        "example"
      ],
      "carBrand": [
        "example"
      ],
      "carNumber": [
        "example"
      ],
      "carType": [
        "example"
      ],
      "cargoIds": [
        "example"
      ],
      "customerIds": [
        "example"
      ],
      "distributionComment": [
        "example"
      ],
      "driverIds": [
        "example"
      ],
      "driverPersonalIds": [
        "example"
      ],
      "edm": {},
      "etrnState": [
        "example"
      ],
      "exactIds": [
        "example"
      ],
      "executorIds": [
        "example"
      ],
      "externalExecutor": [
        "example"
      ],
      "flightGeoAnalyzed": true,
      "flightSubStatus": [
        "example"
      ],
      "flightWayFirstLoadingWayPoint": {},
      "flightWayFirstLoadingWayPointAddresses": [
        "example"
      ],
      "flightWayLastUnloadingWayPoint": null,
      "flightWayLastUnloadingWayPointAddresses": [
        "example"
      ],
      "fromCreateTS": {},
      "fromFirstLoadTS": null,
      "fromFlightWayFirstLoadingWayPointStartAtTS": null,
      "fromFlightWayLastUnloadingWayPointEndAtTS": null,
      "fromLoadingTS": null,
      "fromUnloadingTS": null,
      "fromUpdateTS": null,
      "fwdIds": [
        "example"
      ],
      "ids": [
        "example"
      ],
      "loadPoint": null,
      "npFromAddress": [
        "example"
      ],
      "npShipmentIds": [
        "example"
      ],
      "npToAddress": [
        "example"
      ],
      "npUnshipmentIds": [
        "example"
      ],
      "orderCargoComment": [
        "example"
      ],
      "orderCargoIds": [
        "example"
      ],
      "orderCustomerComment": [
        "example"
      ],
      "orderIds": [
        "example"
      ],
      "packageNames": [
        "example"
      ],
      "partialIds": [
        "example"
      ],
      "responsibleLogisticianByExecutor": [
        "example"
      ],
      "responsibleLogisticianByForwarder": [
        "example"
      ],
      "responsibleLogisticianForOrderByExecutor": [
        "example"
      ],
      "responsibleLogisticianForOrderByForwarder": [
        "example"
      ],
      "shipmentNames": [
        "example"
      ],
      "states": [
        "example"
      ],
      "toCreateTS": null,
      "toFirstLoadTS": null,
      "toFlightWayFirstLoadingWayPointStartAtTS": null,
      "toFlightWayLastUnloadingWayPointEndAtTS": null,
      "toLoadingTS": null,
      "toUnloadingTS": null,
      "toUpdateTS": null,
      "trailerIds": [
        "example"
      ],
      "truckIds": [
        "example"
      ],
      "unloadPoint": null
    },
    "flightSubStatus": [
      "example"
    ],
    "fromCreateTS": null,
    "fromLoadingTS": null,
    "fromUnloadingTS": null,
    "fromUpdateTS": null,
    "fwdIds": [
      "example"
    ],
    "ids": [
      "example"
    ],
    "limit": 0,
    "loadPoint": null,
    "npFromAddress": [
      "example"
    ],
    "npShipmentIds": [
      "example"
    ],
    "npToAddress": [
      "example"
    ],
    "npUnshipmentIds": [
      "example"
    ],
    "orderCargoComment": [
      "example"
    ],
    "orderCargoIds": [
      "example"
    ],
    "orderCustomerComment": [
      "example"
    ],
    "orderIds": [
      "example"
    ],
    "packageNames": [
      "example"
    ],
    "partialIds": [
      "example"
    ],
    "responsibleLogisticianByExecutor": [
      "example"
    ],
    "responsibleLogisticianByForwarder": [
      "example"
    ],
    "responsibleLogisticianForOrderByExecutor": [
      "example"
    ],
    "responsibleLogisticianForOrderByForwarder": [
      "example"
    ],
    "shipmentNames": [
      "example"
    ],
    "sort": {
      "sortSettings": [
        {}
      ]
    },
    "states": [
      "example"
    ],
    "toCreateTS": null,
    "toLoadingTS": null,
    "toUnloadingTS": null,
    "toUpdateTS": null,
    "trailerIds": [
      "example"
    ],
    "truckIds": [
      "example"
    ],
    "unloadPoint": null
  }
}

Name

Description

data

Type: FlightGetListForForwarderRequest

Example
{
  "additionalConditionsExternalOrderID": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoIds": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "exactIds": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalExecutor": [
    "example"
  ],
  "filter": {
    "additionalConditionsExternalOrderID": [
      "example"
    ],
    "bodyTypeComments": [
      "example"
    ],
    "carBodyType": [
      "example"
    ],
    "carBrand": [
      "example"
    ],
    "carNumber": [
      "example"
    ],
    "carType": [
      "example"
    ],
    "cargoIds": [
      "example"
    ],
    "customerIds": [
      "example"
    ],
    "distributionComment": [
      "example"
    ],
    "driverIds": [
      "example"
    ],
    "driverPersonalIds": [
      "example"
    ],
    "edm": {
      "actionRequiredDocumentTypes": [
        null
      ],
      "actionRequiredFromOrganizationIds": [
        null
      ],
      "documentIds": [
        null
      ],
      "epeStatuses": [
        null
      ],
      "etrnStatuses": [
        null
      ],
      "exprStatuses": [
        null
      ],
      "ezzStatuses": [
        null
      ],
      "hasEpe": true,
      "hasEtrn": true,
      "hasExpr": true,
      "hasEzz": true
    },
    "etrnState": [
      "example"
    ],
    "exactIds": [
      "example"
    ],
    "executorIds": [
      "example"
    ],
    "externalExecutor": [
      "example"
    ],
    "flightGeoAnalyzed": true,
    "flightSubStatus": [
      "example"
    ],
    "flightWayFirstLoadingWayPoint": {
      "lat": 0.5,
      "long": 0.5,
      "radiusM": 0.5
    },
    "flightWayFirstLoadingWayPointAddresses": [
      "example"
    ],
    "flightWayLastUnloadingWayPoint": null,
    "flightWayLastUnloadingWayPointAddresses": [
      "example"
    ],
    "fromCreateTS": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "fromFirstLoadTS": null,
    "fromFlightWayFirstLoadingWayPointStartAtTS": null,
    "fromFlightWayLastUnloadingWayPointEndAtTS": null,
    "fromLoadingTS": null,
    "fromUnloadingTS": null,
    "fromUpdateTS": null,
    "fwdIds": [
      "example"
    ],
    "ids": [
      "example"
    ],
    "loadPoint": null,
    "npFromAddress": [
      "example"
    ],
    "npShipmentIds": [
      "example"
    ],
    "npToAddress": [
      "example"
    ],
    "npUnshipmentIds": [
      "example"
    ],
    "orderCargoComment": [
      "example"
    ],
    "orderCargoIds": [
      "example"
    ],
    "orderCustomerComment": [
      "example"
    ],
    "orderIds": [
      "example"
    ],
    "packageNames": [
      "example"
    ],
    "partialIds": [
      "example"
    ],
    "responsibleLogisticianByExecutor": [
      "example"
    ],
    "responsibleLogisticianByForwarder": [
      "example"
    ],
    "responsibleLogisticianForOrderByExecutor": [
      "example"
    ],
    "responsibleLogisticianForOrderByForwarder": [
      "example"
    ],
    "shipmentNames": [
      "example"
    ],
    "states": [
      "example"
    ],
    "toCreateTS": null,
    "toFirstLoadTS": null,
    "toFlightWayFirstLoadingWayPointStartAtTS": null,
    "toFlightWayLastUnloadingWayPointEndAtTS": null,
    "toLoadingTS": null,
    "toUnloadingTS": null,
    "toUpdateTS": null,
    "trailerIds": [
      "example"
    ],
    "truckIds": [
      "example"
    ],
    "unloadPoint": null
  },
  "flightSubStatus": [
    "example"
  ],
  "fromCreateTS": null,
  "fromLoadingTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "fwdIds": [
    "example"
  ],
  "ids": [
    "example"
  ],
  "limit": 0,
  "loadPoint": null,
  "npFromAddress": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npToAddress": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "orderCargoComment": [
    "example"
  ],
  "orderCargoIds": [
    "example"
  ],
  "orderCustomerComment": [
    "example"
  ],
  "orderIds": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialIds": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForOrderByExecutor": [
    "example"
  ],
  "responsibleLogisticianForOrderByForwarder": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "sort": {
    "sortSettings": [
      {
        "field": "example",
        "order": "example"
      }
    ]
  },
  "states": [
    "example"
  ],
  "toCreateTS": null,
  "toLoadingTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadPoint": null
}

FlightSearchEdmFilter

Name

Description

actionRequiredDocumentTypes

Type: string[] | null

ActionRequiredDocumentTypes ограничивает выдачу типами ЭПД, по которым ожидается действие от любого участника.

Example
[
  "example"
]

actionRequiredFromOrganizationIds

Type: string[] | null

ActionRequiredFromOrganizationIDs ограничивает выдачу рейсами, для которых действие с документом ожидается от указанных организаций.

Example
[
  "example"
]

documentIds

Type: string[] | null

DocumentIDs ограничивает выдачу рейсами с указанными идентификаторами документов ЭДО.

Example
[
  "example"
]

epeStatuses

Type: string[] | null

EpeStatuses ограничивает выдачу статусами документов EPE.

Example
[
  "example"
]

etrnStatuses

Type: string[] | null

EtrnStatuses ограничивает выдачу статусами документов ETRN.

Example
[
  "example"
]

exprStatuses

Type: string[] | null

ExprStatuses ограничивает выдачу статусами документов EXPR.

Example
[
  "example"
]

ezzStatuses

Type: string[] | null

EzzStatuses ограничивает выдачу статусами документов EZZ.

Example
[
  "example"
]

hasEpe

Type: boolean | null

hasEtrn

Type: boolean | null

hasExpr

Type: boolean | null

hasEzz

Type: boolean | null
Example
{
  "actionRequiredDocumentTypes": [
    "example"
  ],
  "actionRequiredFromOrganizationIds": [
    "example"
  ],
  "documentIds": [
    "example"
  ],
  "epeStatuses": [
    "example"
  ],
  "etrnStatuses": [
    "example"
  ],
  "exprStatuses": [
    "example"
  ],
  "ezzStatuses": [
    "example"
  ],
  "hasEpe": true,
  "hasEtrn": true,
  "hasExpr": true,
  "hasEzz": true
}

FlightSearchPointRequest

Name

Description

lat

Type: number

long

Type: number

radiusM

Type: number
Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

TimestampTZInput

Name

Description

displayTZ

Type: string

Example: +03:00

time

Type: string<date-time>

Example: 2020-01-01T11:47:38+03:00

useLocation

Type: string

Example: +05:00
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

FlightSearchFilter

Name

Description

additionalConditionsExternalOrderID

Type: string[] | null

Example
[
  "example"
]

bodyTypeComments

Type: string[] | null

Параметр "Комментарий к кузову" в разделе "Перевозка" создания заказа

Example
[
  "example"
]

carBodyType

Type: string[] | null

CarBodyType - Пусто == все

Example
[
  "example"
]

carBrand

Type: string[] | null

CarBrand - Пусто == все

Example
[
  "example"
]

cargoIds

Type: string[] | null

Example
[
  "example"
]

carNumber

Type: string[] | null

CarNumber - Пусто == все

Example
[
  "example"
]

carType

Type: string[] | null

CarType - Пусто == все

Example
[
  "example"
]

customerIds

Type: string[] | null

Example
[
  "example"
]

distributionComment

Type: string[] | null

Параметр "Особые условия перевозки" в разделе "Исполнители" создания заказа

Example
[
  "example"
]

driverIds

Type: string[] | null

DriverIDs - Пусто == все

Example
[
  "example"
]

driverPersonalIds

Type: string[] | null

Example
[
  "example"
]

edm
Any of 2 types

  • Type: FlightSearchEdmFilter

    Example
    {
  "actionRequiredDocumentTypes": [
    "example"
  ],
  "actionRequiredFromOrganizationIds": [
    "example"
  ],
  "documentIds": [
    "example"
  ],
  "epeStatuses": [
    "example"
  ],
  "etrnStatuses": [
    "example"
  ],
  "exprStatuses": [
    "example"
  ],
  "ezzStatuses": [
    "example"
  ],
  "hasEpe": true,
  "hasEtrn": true,
  "hasExpr": true,
  "hasEzz": true
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "actionRequiredDocumentTypes": [
    "example"
  ],
  "actionRequiredFromOrganizationIds": [
    "example"
  ],
  "documentIds": [
    "example"
  ],
  "epeStatuses": [
    "example"
  ],
  "etrnStatuses": [
    "example"
  ],
  "exprStatuses": [
    "example"
  ],
  "ezzStatuses": [
    "example"
  ],
  "hasEpe": true,
  "hasEtrn": true,
  "hasExpr": true,
  "hasEzz": true
}

etrnState

Type: string[] | null

Example
[
  "example"
]

exactIds

Type: string[] | null

Example
[
  "example"
]

executorIds

Type: string[] | null

IDs Не обязательноый параметр

Example
[
  "example"
]

externalExecutor

Type: string[] | null

Example
[
  "example"
]

flightGeoAnalyzed

Type: boolean | null

Признак наличия геоданных по рейсу. Может быть true (должны быть), false (не должны быть) или null (не важно). Последнее значение выключает фильтр

flightSubStatus

Type: string[] | null

Example
[
  "example"
]

flightWayFirstLoadingWayPoint
Any of 2 types

  • Type: FlightSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

координаты и радиус первой погрузки маршрута рейса

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

flightWayFirstLoadingWayPointAddresses

Type: string[] | null

адреса первой погрузки маршрута рейса

Example
[
  "example"
]

flightWayLastUnloadingWayPoint
Any of 2 types

  • Type: FlightSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

координаты и радиус последней разгрузки маршрута рейса

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

flightWayLastUnloadingWayPointAddresses

Type: string[] | null

адреса последней разгрузки маршрута рейса

Example
[
  "example"
]

fromCreateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

FromCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromFirstLoadTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время первой погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromFlightWayFirstLoadingWayPointStartAtTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

дата, после которой которой начинается первая погрузка маршрута рейса

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromFlightWayLastUnloadingWayPointEndAtTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

дата, после которой которой начинается последняя разгрузка маршрута рейса

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromLoadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromUnloadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время разгрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromUpdateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fwdIds

Type: string[] | null

IDs Не обязательноый параметр

Example
[
  "example"
]

ids

Type: string[] | null

IDs Не обязательноый параметр

Example
[
  "example"
]

loadPoint
Any of 2 types

  • Type: FlightSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

LoadPoint - Пусто == все

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

npFromAddress

Type: string[] | null

Example
[
  "example"
]

npShipmentIds

Type: string[] | null

Example
[
  "example"
]

npToAddress

Type: string[] | null

Example
[
  "example"
]

npUnshipmentIds

Type: string[] | null

Example
[
  "example"
]

orderCargoComment

Type: string[] | null

Параметр "Комментарий для себя" в разделе "Перевозка" создания заказа

Example
[
  "example"
]

orderCargoIds

Type: string[] | null

Example
[
  "example"
]

orderCustomerComment

Type: string[] | null

Параметр "Комментарий" в разделе "Владелец груза" создания заказа

Example
[
  "example"
]

orderIds

Type: string[] | null

OrderIDs Не обязательноый параметр

Example
[
  "example"
]

packageNames

Type: string[] | null

Example
[
  "example"
]

partialIds

Type: string[] | null

Example
[
  "example"
]

responsibleLogisticianByExecutor

Type: string[] | null

ResponsibleLogisticianByExecutor id-сотрудников ответсвенных логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianByForwarder

Type: string[] | null

ResponsibleLogisticianByForwarder id-сотрудников ответсвенных логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianForOrderByExecutor

Type: string[] | null

ResponsibleLogisticianForOrderByExecutor id-сотрудников ответсвенных за заказ логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianForOrderByForwarder

Type: string[] | null

ResponsibleLogisticianForOrderByForwarder id-сотрудников ответсвенных за заказ логистов. - Пусто == все

Example
[
  "example"
]

shipmentNames

Type: string[] | null

Example
[
  "example"
]

states

Type: string[] | null

States Статусы рейса Не обязательноый параметр

Example
[
  "example"
]

toCreateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toFirstLoadTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toFlightWayFirstLoadingWayPointStartAtTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

дата, до которой которой заканчивается первая погрузка маршрута рейса

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toFlightWayLastUnloadingWayPointEndAtTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

дата, до которой которой заканчивается последняя разгрузка маршрута рейса

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toLoadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toUnloadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время разгрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toUpdateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

trailerIds

Type: string[] | null

TrailerIDs - Пусто == все

Example
[
  "example"
]

truckIds

Type: string[] | null

CarsIDs - Пусто == все

Example
[
  "example"
]

unloadPoint
Any of 2 types

  • Type: FlightSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

UnloadPoint - Пусто == все

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}
Example
{
  "additionalConditionsExternalOrderID": [
    "example"
  ],
  "bodyTypeComments": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoIds": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "driverPersonalIds": [
    "example"
  ],
  "edm": {
    "actionRequiredDocumentTypes": [
      "example"
    ],
    "actionRequiredFromOrganizationIds": [
      "example"
    ],
    "documentIds": [
      "example"
    ],
    "epeStatuses": [
      "example"
    ],
    "etrnStatuses": [
      "example"
    ],
    "exprStatuses": [
      "example"
    ],
    "ezzStatuses": [
      "example"
    ],
    "hasEpe": true,
    "hasEtrn": true,
    "hasExpr": true,
    "hasEzz": true
  },
  "etrnState": [
    "example"
  ],
  "exactIds": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalExecutor": [
    "example"
  ],
  "flightGeoAnalyzed": true,
  "flightSubStatus": [
    "example"
  ],
  "flightWayFirstLoadingWayPoint": {
    "lat": 0.5,
    "long": 0.5,
    "radiusM": 0.5
  },
  "flightWayFirstLoadingWayPointAddresses": [
    "example"
  ],
  "flightWayLastUnloadingWayPoint": null,
  "flightWayLastUnloadingWayPointAddresses": [
    "example"
  ],
  "fromCreateTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "fromFirstLoadTS": null,
  "fromFlightWayFirstLoadingWayPointStartAtTS": null,
  "fromFlightWayLastUnloadingWayPointEndAtTS": null,
  "fromLoadingTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "fwdIds": [
    "example"
  ],
  "ids": [
    "example"
  ],
  "loadPoint": null,
  "npFromAddress": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npToAddress": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "orderCargoComment": [
    "example"
  ],
  "orderCargoIds": [
    "example"
  ],
  "orderCustomerComment": [
    "example"
  ],
  "orderIds": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialIds": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForOrderByExecutor": [
    "example"
  ],
  "responsibleLogisticianForOrderByForwarder": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "states": [
    "example"
  ],
  "toCreateTS": null,
  "toFirstLoadTS": null,
  "toFlightWayFirstLoadingWayPointStartAtTS": null,
  "toFlightWayLastUnloadingWayPointEndAtTS": null,
  "toLoadingTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadPoint": null
}

FlightSearchSortSetting

Name

Description

field

Type: string

Example: example

order

Type: string | null

Example: example
Example
{
  "field": "example",
  "order": "example"
}

FlightSearchSort

Name

Description

sortSettings

Type: FlightSearchSortSetting[] | null

Example
[
  {
    "field": "example",
    "order": "example"
  }
]
Example
{
  "sortSettings": [
    {
      "field": "example",
      "order": "example"
    }
  ]
}

FlightGetListForForwarderRequest

Name

Description

additionalConditionsExternalOrderID

Type: string[] | null

Example
[
  "example"
]

carBodyType

Type: string[] | null

CarBodyType - Пусто == все

Example
[
  "example"
]

carBrand

Type: string[] | null

CarBrand - Пусто == все

Example
[
  "example"
]

cargoIds

Type: string[] | null

Example
[
  "example"
]

carNumber

Type: string[] | null

CarNumber - Пусто == все

Example
[
  "example"
]

carType

Type: string[] | null

CarType - Пусто == все

Example
[
  "example"
]

customerIds

Type: string[] | null

Example
[
  "example"
]

distributionComment

Type: string[] | null

Параметр "Особые условия перевозки" в разделе "Исполнители" создания заказа

Example
[
  "example"
]

driverIds

Type: string[] | null

DriverIDs - Пусто == все

Example
[
  "example"
]

exactIds

Type: string[] | null

Example
[
  "example"
]

executorIds

Type: string[] | null

IDs Не обязательноый параметр

Example
[
  "example"
]

externalExecutor

Type: string[] | null

Example
[
  "example"
]

filter
Any of 2 types

  • Type: FlightSearchFilter

    Example
    {
  "additionalConditionsExternalOrderID": [
    "example"
  ],
  "bodyTypeComments": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoIds": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "driverPersonalIds": [
    "example"
  ],
  "edm": {
    "actionRequiredDocumentTypes": [
      "example"
    ],
    "actionRequiredFromOrganizationIds": [
      "example"
    ],
    "documentIds": [
      "example"
    ],
    "epeStatuses": [
      "example"
    ],
    "etrnStatuses": [
      "example"
    ],
    "exprStatuses": [
      "example"
    ],
    "ezzStatuses": [
      "example"
    ],
    "hasEpe": true,
    "hasEtrn": true,
    "hasExpr": true,
    "hasEzz": true
  },
  "etrnState": [
    "example"
  ],
  "exactIds": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalExecutor": [
    "example"
  ],
  "flightGeoAnalyzed": true,
  "flightSubStatus": [
    "example"
  ],
  "flightWayFirstLoadingWayPoint": {
    "lat": 0.5,
    "long": 0.5,
    "radiusM": 0.5
  },
  "flightWayFirstLoadingWayPointAddresses": [
    "example"
  ],
  "flightWayLastUnloadingWayPoint": null,
  "flightWayLastUnloadingWayPointAddresses": [
    "example"
  ],
  "fromCreateTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "fromFirstLoadTS": null,
  "fromFlightWayFirstLoadingWayPointStartAtTS": null,
  "fromFlightWayLastUnloadingWayPointEndAtTS": null,
  "fromLoadingTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "fwdIds": [
    "example"
  ],
  "ids": [
    "example"
  ],
  "loadPoint": null,
  "npFromAddress": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npToAddress": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "orderCargoComment": [
    "example"
  ],
  "orderCargoIds": [
    "example"
  ],
  "orderCustomerComment": [
    "example"
  ],
  "orderIds": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialIds": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForOrderByExecutor": [
    "example"
  ],
  "responsibleLogisticianForOrderByForwarder": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "states": [
    "example"
  ],
  "toCreateTS": null,
  "toFirstLoadTS": null,
  "toFlightWayFirstLoadingWayPointStartAtTS": null,
  "toFlightWayLastUnloadingWayPointEndAtTS": null,
  "toLoadingTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadPoint": null
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "additionalConditionsExternalOrderID": [
    "example"
  ],
  "bodyTypeComments": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoIds": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "driverPersonalIds": [
    "example"
  ],
  "edm": {
    "actionRequiredDocumentTypes": [
      "example"
    ],
    "actionRequiredFromOrganizationIds": [
      "example"
    ],
    "documentIds": [
      "example"
    ],
    "epeStatuses": [
      "example"
    ],
    "etrnStatuses": [
      "example"
    ],
    "exprStatuses": [
      "example"
    ],
    "ezzStatuses": [
      "example"
    ],
    "hasEpe": true,
    "hasEtrn": true,
    "hasExpr": true,
    "hasEzz": true
  },
  "etrnState": [
    "example"
  ],
  "exactIds": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalExecutor": [
    "example"
  ],
  "flightGeoAnalyzed": true,
  "flightSubStatus": [
    "example"
  ],
  "flightWayFirstLoadingWayPoint": {
    "lat": 0.5,
    "long": 0.5,
    "radiusM": 0.5
  },
  "flightWayFirstLoadingWayPointAddresses": [
    "example"
  ],
  "flightWayLastUnloadingWayPoint": null,
  "flightWayLastUnloadingWayPointAddresses": [
    "example"
  ],
  "fromCreateTS": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T11:47:38+03:00",
    "useLocation": "+05:00"
  },
  "fromFirstLoadTS": null,
  "fromFlightWayFirstLoadingWayPointStartAtTS": null,
  "fromFlightWayLastUnloadingWayPointEndAtTS": null,
  "fromLoadingTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "fwdIds": [
    "example"
  ],
  "ids": [
    "example"
  ],
  "loadPoint": null,
  "npFromAddress": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npToAddress": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "orderCargoComment": [
    "example"
  ],
  "orderCargoIds": [
    "example"
  ],
  "orderCustomerComment": [
    "example"
  ],
  "orderIds": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialIds": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForOrderByExecutor": [
    "example"
  ],
  "responsibleLogisticianForOrderByForwarder": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "states": [
    "example"
  ],
  "toCreateTS": null,
  "toFirstLoadTS": null,
  "toFlightWayFirstLoadingWayPointStartAtTS": null,
  "toFlightWayLastUnloadingWayPointEndAtTS": null,
  "toLoadingTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadPoint": null
}

flightSubStatus

Type: string[] | null

Example
[
  "example"
]

fromCreateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

FromCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromLoadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromUnloadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время разгрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fromUpdateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

fwdIds

Type: string[] | null

IDs Не обязательноый параметр

Example
[
  "example"
]

ids

Type: string[] | null

IDs Не обязательноый параметр

Example
[
  "example"
]

limit

Type: integer | null

Limit ограничение на количество рейсов на выходе. - Пусто == все

loadPoint
Any of 2 types

  • Type: FlightSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

LoadPoint - Пусто == все

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

npFromAddress

Type: string[] | null

Example
[
  "example"
]

npShipmentIds

Type: string[] | null

Example
[
  "example"
]

npToAddress

Type: string[] | null

Example
[
  "example"
]

npUnshipmentIds

Type: string[] | null

Example
[
  "example"
]

orderCargoComment

Type: string[] | null

Параметр "Комментарий для себя" в разделе "Перевозка" создания заказа

Example
[
  "example"
]

orderCargoIds

Type: string[] | null

Example
[
  "example"
]

orderCustomerComment

Type: string[] | null

Параметр "Комментарий" в разделе "Владелец груза" создания заказа

Example
[
  "example"
]

orderIds

Type: string[] | null

OrderIDs Не обязательноый параметр

Example
[
  "example"
]

packageNames

Type: string[] | null

Example
[
  "example"
]

partialIds

Type: string[] | null

Example
[
  "example"
]

responsibleLogisticianByExecutor

Type: string[] | null

ResponsibleLogisticianByExecutor id-сотрудников ответсвенных логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianByForwarder

Type: string[] | null

ResponsibleLogisticianByForwarder id-сотрудников ответсвенных логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianForOrderByExecutor

Type: string[] | null

ResponsibleLogisticianForOrderByExecutor id-сотрудников ответсвенных за заказ логистов. - Пусто == все

Example
[
  "example"
]

responsibleLogisticianForOrderByForwarder

Type: string[] | null

ResponsibleLogisticianForOrderByForwarder id-сотрудников ответсвенных за заказ логистов. - Пусто == все

Example
[
  "example"
]

shipmentNames

Type: string[] | null

Example
[
  "example"
]

sort
Any of 2 types

  • Type: FlightSearchSort

    Example
    {
  "sortSettings": [
    {
      "field": "example",
      "order": "example"
    }
  ]
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "sortSettings": [
    {
      "field": "example",
      "order": "example"
    }
  ]
}

states

Type: string[] | null

States Статусы рейса Не обязательноый параметр

Example
[
  "example"
]

toCreateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toLoadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время погрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toUnloadingTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Время разгрузки.

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

toUpdateTS
Any of 2 types

  • Type: TimestampTZInput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

  • Type: object | null

    Const: null

    Example
    {}

ToCreateTS Не обязательноый параметр

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T11:47:38+03:00",
  "useLocation": "+05:00"
}

trailerIds

Type: string[] | null

TrailerIDs - Пусто == все

Example
[
  "example"
]

truckIds

Type: string[] | null

CarsIDs - Пусто == все

Example
[
  "example"
]

unloadPoint
Any of 2 types

  • Type: FlightSearchPointRequest

    Example
    {
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

UnloadPoint - Пусто == все

Example
{
  "lat": 0.5,
  "long": 0.5,
  "radiusM": 0.5
}
Example
{
  "additionalConditionsExternalOrderID": [
    "example"
  ],
  "carBodyType": [
    "example"
  ],
  "carBrand": [
    "example"
  ],
  "carNumber": [
    "example"
  ],
  "carType": [
    "example"
  ],
  "cargoIds": [
    "example"
  ],
  "customerIds": [
    "example"
  ],
  "distributionComment": [
    "example"
  ],
  "driverIds": [
    "example"
  ],
  "exactIds": [
    "example"
  ],
  "executorIds": [
    "example"
  ],
  "externalExecutor": [
    "example"
  ],
  "filter": {
    "additionalConditionsExternalOrderID": [
      "example"
    ],
    "bodyTypeComments": [
      "example"
    ],
    "carBodyType": [
      "example"
    ],
    "carBrand": [
      "example"
    ],
    "carNumber": [
      "example"
    ],
    "carType": [
      "example"
    ],
    "cargoIds": [
      "example"
    ],
    "customerIds": [
      "example"
    ],
    "distributionComment": [
      "example"
    ],
    "driverIds": [
      "example"
    ],
    "driverPersonalIds": [
      "example"
    ],
    "edm": {
      "actionRequiredDocumentTypes": [
        null
      ],
      "actionRequiredFromOrganizationIds": [
        null
      ],
      "documentIds": [
        null
      ],
      "epeStatuses": [
        null
      ],
      "etrnStatuses": [
        null
      ],
      "exprStatuses": [
        null
      ],
      "ezzStatuses": [
        null
      ],
      "hasEpe": true,
      "hasEtrn": true,
      "hasExpr": true,
      "hasEzz": true
    },
    "etrnState": [
      "example"
    ],
    "exactIds": [
      "example"
    ],
    "executorIds": [
      "example"
    ],
    "externalExecutor": [
      "example"
    ],
    "flightGeoAnalyzed": true,
    "flightSubStatus": [
      "example"
    ],
    "flightWayFirstLoadingWayPoint": {
      "lat": 0.5,
      "long": 0.5,
      "radiusM": 0.5
    },
    "flightWayFirstLoadingWayPointAddresses": [
      "example"
    ],
    "flightWayLastUnloadingWayPoint": null,
    "flightWayLastUnloadingWayPointAddresses": [
      "example"
    ],
    "fromCreateTS": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T11:47:38+03:00",
      "useLocation": "+05:00"
    },
    "fromFirstLoadTS": null,
    "fromFlightWayFirstLoadingWayPointStartAtTS": null,
    "fromFlightWayLastUnloadingWayPointEndAtTS": null,
    "fromLoadingTS": null,
    "fromUnloadingTS": null,
    "fromUpdateTS": null,
    "fwdIds": [
      "example"
    ],
    "ids": [
      "example"
    ],
    "loadPoint": null,
    "npFromAddress": [
      "example"
    ],
    "npShipmentIds": [
      "example"
    ],
    "npToAddress": [
      "example"
    ],
    "npUnshipmentIds": [
      "example"
    ],
    "orderCargoComment": [
      "example"
    ],
    "orderCargoIds": [
      "example"
    ],
    "orderCustomerComment": [
      "example"
    ],
    "orderIds": [
      "example"
    ],
    "packageNames": [
      "example"
    ],
    "partialIds": [
      "example"
    ],
    "responsibleLogisticianByExecutor": [
      "example"
    ],
    "responsibleLogisticianByForwarder": [
      "example"
    ],
    "responsibleLogisticianForOrderByExecutor": [
      "example"
    ],
    "responsibleLogisticianForOrderByForwarder": [
      "example"
    ],
    "shipmentNames": [
      "example"
    ],
    "states": [
      "example"
    ],
    "toCreateTS": null,
    "toFirstLoadTS": null,
    "toFlightWayFirstLoadingWayPointStartAtTS": null,
    "toFlightWayLastUnloadingWayPointEndAtTS": null,
    "toLoadingTS": null,
    "toUnloadingTS": null,
    "toUpdateTS": null,
    "trailerIds": [
      "example"
    ],
    "truckIds": [
      "example"
    ],
    "unloadPoint": null
  },
  "flightSubStatus": [
    "example"
  ],
  "fromCreateTS": null,
  "fromLoadingTS": null,
  "fromUnloadingTS": null,
  "fromUpdateTS": null,
  "fwdIds": [
    "example"
  ],
  "ids": [
    "example"
  ],
  "limit": 0,
  "loadPoint": null,
  "npFromAddress": [
    "example"
  ],
  "npShipmentIds": [
    "example"
  ],
  "npToAddress": [
    "example"
  ],
  "npUnshipmentIds": [
    "example"
  ],
  "orderCargoComment": [
    "example"
  ],
  "orderCargoIds": [
    "example"
  ],
  "orderCustomerComment": [
    "example"
  ],
  "orderIds": [
    "example"
  ],
  "packageNames": [
    "example"
  ],
  "partialIds": [
    "example"
  ],
  "responsibleLogisticianByExecutor": [
    "example"
  ],
  "responsibleLogisticianByForwarder": [
    "example"
  ],
  "responsibleLogisticianForOrderByExecutor": [
    "example"
  ],
  "responsibleLogisticianForOrderByForwarder": [
    "example"
  ],
  "shipmentNames": [
    "example"
  ],
  "sort": {
    "sortSettings": [
      {
        "field": "example",
        "order": "example"
      }
    ]
  },
  "states": [
    "example"
  ],
  "toCreateTS": null,
  "toLoadingTS": null,
  "toUnloadingTS": null,
  "toUpdateTS": null,
  "trailerIds": [
    "example"
  ],
  "truckIds": [
    "example"
  ],
  "unloadPoint": null
}

Responses

200 OK

OK

Body

application/json
{
  "data": {
    "flights": [
      {
        "alerts": [
          {}
        ],
        "canSetCar": true,
        "canSetDriver": true,
        "canSetStatus": true,
        "canceledAt": {},
        "completedAt": null,
        "driver": {},
        "executer": {
          "id": "example",
          "isUnverified": true,
          "name": "example",
          "tin": "example"
        },
        "executerId": "example",
        "extId": "example",
        "externalExecutor": {},
        "flightName": "example",
        "flightWay": {},
        "id": "example",
        "isForwardingCompany": true,
        "responsibleLogistician": {},
        "status": "example",
        "subStatus": "example",
        "tasks": [
          {}
        ],
        "trailer": {},
        "truck": null
      }
    ]
  }
}

Name

Description

data

Type: FlightGetListForForwarderResponse

Example
{
  "flights": [
    {
      "alerts": [
        {
          "alertType": "example",
          "description": "example"
        }
      ],
      "canSetCar": true,
      "canSetDriver": true,
      "canSetStatus": true,
      "canceledAt": {
        "displayTZ": "+03:00",
        "time": "2020-01-01T00:00:00"
      },
      "completedAt": null,
      "driver": {
        "id": "example",
        "isActual": true,
        "masked_phone": "example",
        "name": "example"
      },
      "executer": {
        "id": "example",
        "isUnverified": true,
        "name": "example",
        "tin": "example"
      },
      "executerId": "example",
      "extId": "example",
      "externalExecutor": {
        "contactEmail": "example",
        "contactName": "example",
        "contactPhone": "example",
        "country": "example",
        "legalAddress": "example",
        "name": "example",
        "orgType": "example",
        "tin": "example",
        "vat": 0.5
      },
      "flightName": "example",
      "flightWay": {
        "archivedAt": null,
        "createdAt": null,
        "generationType": "example",
        "id": "example",
        "updatedAt": null,
        "visits": [
          null
        ]
      },
      "id": "example",
      "isForwardingCompany": true,
      "responsibleLogistician": {
        "name": "example",
        "orgId": "example",
        "orgName": "example",
        "orgTin": "example",
        "publicEmail": "example",
        "publicPhone": "example",
        "type": "example",
        "value": "example"
      },
      "status": "example",
      "subStatus": "example",
      "tasks": [
        {
          "comment": "example",
          "flightInfo": null,
          "flightTaskId": "example",
          "isDeleted": true,
          "isRevoked": true,
          "name": "example",
          "npShipment": {},
          "npShipmentId": "example",
          "npUnshipment": null,
          "orderInfo": null,
          "packageType": "example",
          "packages": [
            null
          ],
          "revokedAt": null,
          "shipmentId": "example",
          "taskStatus": "example",
          "transferOrderTaskID": "example"
        }
      ],
      "trailer": {
        "bodyType": "example",
        "brand": "example",
        "createdAt": null,
        "documents": [
          null
        ],
        "height": 0.5,
        "hydroBort": true,
        "id": "example",
        "imei": [
          null
        ],
        "length": 0.5,
        "loadCapacity": 0.5,
        "model": "example",
        "number": "example",
        "orgIdAllowed": [
          null
        ],
        "ownerCountry": "example",
        "ownerId": "example",
        "ownerName": "example",
        "ownershipContactId": "example",
        "ownershipDetails": null,
        "ownershipType": "example",
        "palletCount": 0,
        "registrationCountry": "example",
        "type": "example",
        "vin": "example",
        "volume": 0.5,
        "width": 0.5
      },
      "truck": null
    }
  ]
}

FlightGetListForForwarderAlertInfo

Name

Description

alertType

Type: string

Example: example

description

Type: string

Example: example
Example
{
  "alertType": "example",
  "description": "example"
}

TimestampTZOutput

Name

Description

displayTZ

Type: string

Example: +03:00

time

Type: string<date-time>

Example: 2020-01-01T00:00:00
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

FlightGetListForForwarderDriverInfo

Name

Description

id

Type: string

Example: example

isActual

Type: boolean

masked_phone

Type: string

Example: example

name

Type: string

Example: example
Example
{
  "id": "example",
  "isActual": true,
  "masked_phone": "example",
  "name": "example"
}

FlightGetListForForwarderOrgInfo

Name

Description

id

Type: string

Example: example

name

Type: string

Example: example

tin

Type: string

Example: example

isUnverified

Type: boolean | null
Example
{
  "id": "example",
  "isUnverified": true,
  "name": "example",
  "tin": "example"
}

FlightGetListForForwarderExternalExecutor

Name

Description

country

Type: string

Example: example

name

Type: string

Example: example

orgType

Type: string

Example: example

tin

Type: string

Код типа доступа к коменнтарию

Example: example

contactEmail

Type: string | null

Example: example

contactName

Type: string | null

Example: example

contactPhone

Type: string | null

Example: example

legalAddress

Type: string | null

Юридический адрес одной строкой

Example: example

vat

Type: number | null
Example
{
  "contactEmail": "example",
  "contactName": "example",
  "contactPhone": "example",
  "country": "example",
  "legalAddress": "example",
  "name": "example",
  "orgType": "example",
  "tin": "example",
  "vat": 0.5
}

FlightGetListForForwarderFlightWayActionRelation

Name

Description

flightId

Type: string

ID рейса

Example: example

flightTaskId

Type: string

ID задачи перевозки

Example: example

isTransferTaskDeleted

Type: boolean

Задача на перевозку (Груз) удалена из заказа

isTransferTaskRevoked

Type: boolean

Задача на перевозку (Груз) отозвана из исполнения у исполнителя

orderId

Type: string

ID заказа

Example: example

shipmentId

Type: string

ID груза

Example: example

shipmentName

Type: string

Название груза

Example: example

transferTaskId

Type: string

ID задачи перевозки

Example: example
Example
{
  "flightId": "example",
  "flightTaskId": "example",
  "isTransferTaskDeleted": true,
  "isTransferTaskRevoked": true,
  "orderId": "example",
  "shipmentId": "example",
  "shipmentName": "example",
  "transferTaskId": "example"
}

FlightGetListForForwarderFlightWayAction

Name

Description

actionId

Type: string

ID действия

Example: example

actionType

Type: string

Что нужно сделать на маршруте (loading - погрузить груз, unloading - выгрузить груз, transit - не выгружать уже погруженный груз)

Example: example

orderInVisit

Type: integer

порядок выполнения задач в узле

relation
Any of 2 types

  • Type: FlightGetListForForwarderFlightWayActionRelation

    Example
    {
  "flightId": "example",
  "flightTaskId": "example",
  "isTransferTaskDeleted": true,
  "isTransferTaskRevoked": true,
  "orderId": "example",
  "shipmentId": "example",
  "shipmentName": "example",
  "transferTaskId": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Связь с задачей перевозки (груз, заказ, рейс)

Example
{
  "flightId": "example",
  "flightTaskId": "example",
  "isTransferTaskDeleted": true,
  "isTransferTaskRevoked": true,
  "orderId": "example",
  "shipmentId": "example",
  "shipmentName": "example",
  "transferTaskId": "example"
}
Example
{
  "actionId": "example",
  "actionType": "example",
  "orderInVisit": 0,
  "relation": {
    "flightId": "example",
    "flightTaskId": "example",
    "isTransferTaskDeleted": true,
    "isTransferTaskRevoked": true,
    "orderId": "example",
    "shipmentId": "example",
    "shipmentName": "example",
    "transferTaskId": "example"
  }
}

FlightGetListForForwarderFlightWayPoint

Name

Description

address

Type: string

Адрес точки

Example: example

id

Type: string

ID точки

Example: example

lat

Type: number

Широта точки

locality

Type: string

Город точки

Example: example

long

Type: number

Долгота точки

province

Type: string

Провинция точки

Example: example

addressComment

Type: string | null

Комментарий к адресу

Example: example

name

Type: string | null

Название точки

Example: example

tin

Type: string | null

ИНН точки

Example: example
Example
{
  "address": "example",
  "addressComment": "example",
  "id": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "name": "example",
  "province": "example",
  "tin": "example"
}

FlightGetListForForwarderFlightWayVisit

Name

Description

id

Type: string

ID посещения

Example: example

orderInWay

Type: integer

Порядок посещения точек в маршруте

startAt
All of 1 type

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

Дата начала посещения

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

actions

Type: FlightGetListForForwarderFlightWayAction[] | null

Действия, которые нужно выполнить на маршруте

Example
[
  {
    "actionId": "example",
    "actionType": "example",
    "orderInVisit": 0,
    "relation": {
      "flightId": "example",
      "flightTaskId": "example",
      "isTransferTaskDeleted": true,
      "isTransferTaskRevoked": true,
      "orderId": "example",
      "shipmentId": "example",
      "shipmentName": "example",
      "transferTaskId": "example"
    }
  }
]

endAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата окончания посещения

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

wayPoint
Any of 2 types

  • Type: FlightGetListForForwarderFlightWayPoint

    Example
    {
  "address": "example",
  "addressComment": "example",
  "id": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "name": "example",
  "province": "example",
  "tin": "example"
}

  • Type: object | null

    Const: null

    Example
    {}

Точка на маршруте

Example
{
  "address": "example",
  "addressComment": "example",
  "id": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "name": "example",
  "province": "example",
  "tin": "example"
}
Example
{
  "actions": [
    {
      "actionId": "example",
      "actionType": "example",
      "orderInVisit": 0,
      "relation": {
        "flightId": "example",
        "flightTaskId": "example",
        "isTransferTaskDeleted": true,
        "isTransferTaskRevoked": true,
        "orderId": "example",
        "shipmentId": "example",
        "shipmentName": "example",
        "transferTaskId": "example"
      }
    }
  ],
  "endAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "id": "example",
  "orderInWay": 0,
  "startAt": null,
  "wayPoint": {
    "address": "example",
    "addressComment": "example",
    "id": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "name": "example",
    "province": "example",
    "tin": "example"
  }
}

FlightGetListForForwarderFlightWay

Name

Description

createdAt
All of 1 type

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

Дата создания маршрута

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

generationType

Type: string

Тип генерации (auto / manual)

Example: example

id

Type: string

ID версии маршрута

Example: example

updatedAt
All of 1 type

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

Дата обновления маршрута

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

archivedAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Дата архивации маршрута

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

visits

Type: FlightGetListForForwarderFlightWayVisit[] | null

Посещения точек на маршруте следования

Example
[
  {
    "actions": [
      {
        "actionId": "example",
        "actionType": "example",
        "orderInVisit": 0,
        "relation": {}
      }
    ],
    "endAt": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "id": "example",
    "orderInWay": 0,
    "startAt": null,
    "wayPoint": {
      "address": "example",
      "addressComment": "example",
      "id": "example",
      "lat": 0.5,
      "locality": "example",
      "long": 0.5,
      "name": "example",
      "province": "example",
      "tin": "example"
    }
  }
]
Example
{
  "archivedAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "createdAt": null,
  "generationType": "example",
  "id": "example",
  "updatedAt": null,
  "visits": [
    {
      "actions": [
        {
          "actionId": "example",
          "actionType": "example",
          "orderInVisit": 0,
          "relation": null
        }
      ],
      "endAt": null,
      "id": "example",
      "orderInWay": 0,
      "startAt": null,
      "wayPoint": {
        "address": "example",
        "addressComment": "example",
        "id": "example",
        "lat": 0.5,
        "locality": "example",
        "long": 0.5,
        "name": "example",
        "province": "example",
        "tin": "example"
      }
    }
  ]
}

TimestampTZOutputContact

Name

Description

name

Type: string

Example: example

orgId

Type: string | null

Example: example

orgName

Type: string | null

Example: example

orgTin

Type: string | null

Example: example

publicEmail

Type: string | null

Example: example

publicPhone

Type: string | null

Example: example

type

Type: string

Example: example

value

Type: string

Example: example
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

FlightGetListForForwarderDocument

Name

Description

expiration

Type: TimestampTZOutput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

issueDate

Type: TimestampTZOutput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

name

Type: string

Example: example

number

Type: string

Example: example
Example
{
  "expiration": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "issueDate": null,
  "name": "example",
  "number": "example"
}

FlightGetListForForwarderOwnershipDetails

Name

Description

companyName

Type: string

Example: example

contractDate

Type: TimestampTZOutput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

contractName

Type: string

Example: example

contractNumber

Type: string

Example: example

ownerTIN

Type: string

Example: example

ownerType

Type: string

Example: example
Example
{
  "companyName": "example",
  "contractDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "contractName": "example",
  "contractNumber": "example",
  "ownerTIN": "example",
  "ownerType": "example"
}

FlightGetListForForwarderCarInfo

Name

Description

bodyType

Type: string

Example: example

brand

Type: string

Бренд (марка) автомобиля

Example: example

createdAt
All of 1 type

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

Дата создания автомобиля

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

height

Type: number

hydroBort

Type: boolean

id

Type: string

Example: example

length

Type: number

loadCapacity

Type: number

model

Type: string

Example: example

number

Type: string

Example: example

ownerCountry

Type: string

Страна владельца

Example: example

ownerId

Type: string

Идентификатор владельца

Example: example

ownerName

Type: string

Имя владельца автомобиля

Example: example

ownershipType

Type: string

Тип владения ТС (собственность, совместная собственность супругов, лизинг, безвозмездное пользование, аренда)

Example: example

palletCount

Type: integer

registrationCountry

Type: string

Страна регистрации автомобиля

Example: example

type

Type: string

Example: example

vin

Type: string

VIN-номер автомобиля

Example: example

volume

Type: number

width

Type: number

documents

Type: FlightGetListForForwarderDocument[] | null

Example
[
  {
    "expiration": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "issueDate": null,
    "name": "example",
    "number": "example"
  }
]

imei

Type: string[] | null

Список IMEI

Example
[
  "example"
]

orgIdAllowed

Type: string[] | null

Список разрешённых организаций, для которых данный автомобиль может быть использован

Example
[
  "example"
]

ownershipContactId

Type: string | null

Id контакта владельца ТС

Example: example

ownershipDetails
Any of 2 types

  • Type: FlightGetListForForwarderOwnershipDetails

    Example
    {
  "companyName": "example",
  "contractDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "contractName": "example",
  "contractNumber": "example",
  "ownerTIN": "example",
  "ownerType": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "companyName": "example",
  "contractDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "contractName": "example",
  "contractNumber": "example",
  "ownerTIN": "example",
  "ownerType": "example"
}
Example
{
  "bodyType": "example",
  "brand": "example",
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "documents": [
    {
      "expiration": null,
      "issueDate": null,
      "name": "example",
      "number": "example"
    }
  ],
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "imei": [
    "example"
  ],
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "orgIdAllowed": [
    "example"
  ],
  "ownerCountry": "example",
  "ownerId": "example",
  "ownerName": "example",
  "ownershipContactId": "example",
  "ownershipDetails": {
    "companyName": "example",
    "contractDate": null,
    "contractName": "example",
    "contractNumber": "example",
    "ownerTIN": "example",
    "ownerType": "example"
  },
  "ownershipType": "example",
  "palletCount": 0,
  "registrationCountry": "example",
  "type": "example",
  "vin": "example",
  "volume": 0.5,
  "width": 0.5
}

FlightGetListForForwarderFlightTaskFlightInfo

Name

Description

canSetCar

Type: boolean

canSetDriver

Type: boolean

canSetStatus

Type: boolean

flightId

Type: string

Example: example

flightTaskId

Type: string

Example: example

flightTaskStatus

Type: string

Example: example

status

Type: string

Example: example

subStatus

Type: string

Example: example

arrivalLoadingAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

arrivalUnloadingAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

carHeadInfo
Any of 2 types

  • Type: FlightGetListForForwarderCarInfo

    Example
    {
  "bodyType": "example",
  "brand": "example",
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "documents": [
    {
      "expiration": null,
      "issueDate": null,
      "name": "example",
      "number": "example"
    }
  ],
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "imei": [
    "example"
  ],
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "orgIdAllowed": [
    "example"
  ],
  "ownerCountry": "example",
  "ownerId": "example",
  "ownerName": "example",
  "ownershipContactId": "example",
  "ownershipDetails": {
    "companyName": "example",
    "contractDate": null,
    "contractName": "example",
    "contractNumber": "example",
    "ownerTIN": "example",
    "ownerType": "example"
  },
  "ownershipType": "example",
  "palletCount": 0,
  "registrationCountry": "example",
  "type": "example",
  "vin": "example",
  "volume": 0.5,
  "width": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "bodyType": "example",
  "brand": "example",
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "documents": [
    {
      "expiration": null,
      "issueDate": null,
      "name": "example",
      "number": "example"
    }
  ],
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "imei": [
    "example"
  ],
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "orgIdAllowed": [
    "example"
  ],
  "ownerCountry": "example",
  "ownerId": "example",
  "ownerName": "example",
  "ownershipContactId": "example",
  "ownershipDetails": {
    "companyName": "example",
    "contractDate": null,
    "contractName": "example",
    "contractNumber": "example",
    "ownerTIN": "example",
    "ownerType": "example"
  },
  "ownershipType": "example",
  "palletCount": 0,
  "registrationCountry": "example",
  "type": "example",
  "vin": "example",
  "volume": 0.5,
  "width": 0.5
}

departureLoadingAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

departureUnloadingAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

driverInfo
Any of 2 types

  • Type: FlightGetListForForwarderDriverInfo

    Example
    {
  "id": "example",
  "isActual": true,
  "masked_phone": "example",
  "name": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "id": "example",
  "isActual": true,
  "masked_phone": "example",
  "name": "example"
}

endLoadingAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

endUnloadingAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

goToTheLoadingAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

loadingOrder

Type: integer | null

startLoadingAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

startUnloadingAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

trailerInfo
Any of 2 types

  • Type: FlightGetListForForwarderCarInfo

    Example
    {
  "bodyType": "example",
  "brand": "example",
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "documents": [
    {
      "expiration": null,
      "issueDate": null,
      "name": "example",
      "number": "example"
    }
  ],
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "imei": [
    "example"
  ],
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "orgIdAllowed": [
    "example"
  ],
  "ownerCountry": "example",
  "ownerId": "example",
  "ownerName": "example",
  "ownershipContactId": "example",
  "ownershipDetails": {
    "companyName": "example",
    "contractDate": null,
    "contractName": "example",
    "contractNumber": "example",
    "ownerTIN": "example",
    "ownerType": "example"
  },
  "ownershipType": "example",
  "palletCount": 0,
  "registrationCountry": "example",
  "type": "example",
  "vin": "example",
  "volume": 0.5,
  "width": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "bodyType": "example",
  "brand": "example",
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "documents": [
    {
      "expiration": null,
      "issueDate": null,
      "name": "example",
      "number": "example"
    }
  ],
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "imei": [
    "example"
  ],
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "orgIdAllowed": [
    "example"
  ],
  "ownerCountry": "example",
  "ownerId": "example",
  "ownerName": "example",
  "ownershipContactId": "example",
  "ownershipDetails": {
    "companyName": "example",
    "contractDate": null,
    "contractName": "example",
    "contractNumber": "example",
    "ownerTIN": "example",
    "ownerType": "example"
  },
  "ownershipType": "example",
  "palletCount": 0,
  "registrationCountry": "example",
  "type": "example",
  "vin": "example",
  "volume": 0.5,
  "width": 0.5
}

unloadingOrder

Type: integer | null
Example
{
  "arrivalLoadingAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "arrivalUnloadingAt": null,
  "canSetCar": true,
  "canSetDriver": true,
  "canSetStatus": true,
  "carHeadInfo": {
    "bodyType": "example",
    "brand": "example",
    "createdAt": null,
    "documents": [
      {
        "expiration": null,
        "issueDate": null,
        "name": "example",
        "number": "example"
      }
    ],
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "imei": [
      "example"
    ],
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "orgIdAllowed": [
      "example"
    ],
    "ownerCountry": "example",
    "ownerId": "example",
    "ownerName": "example",
    "ownershipContactId": "example",
    "ownershipDetails": {
      "companyName": "example",
      "contractDate": null,
      "contractName": "example",
      "contractNumber": "example",
      "ownerTIN": "example",
      "ownerType": "example"
    },
    "ownershipType": "example",
    "palletCount": 0,
    "registrationCountry": "example",
    "type": "example",
    "vin": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "departureLoadingAt": null,
  "departureUnloadingAt": null,
  "driverInfo": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "endLoadingAt": null,
  "endUnloadingAt": null,
  "flightId": "example",
  "flightTaskId": "example",
  "flightTaskStatus": "example",
  "goToTheLoadingAt": null,
  "loadingOrder": 0,
  "startLoadingAt": null,
  "startUnloadingAt": null,
  "status": "example",
  "subStatus": "example",
  "trailerInfo": null,
  "unloadingOrder": 0
}

FlightGetListForForwarderNodalPointAdditionalContact

Name

Description

id

Type: string

Example: example

npcName

Type: string

Имя контактного лица.

Example: example

npcPhone

Type: string

Телефон контактного лица.

Example: example

npcExternalId

Type: string | null

Идентификатор контакта в системе клиента.

Example: example
Example
{
  "id": "example",
  "npcExternalId": "example",
  "npcName": "example",
  "npcPhone": "example"
}

FlightGetListForForwarderNpGeoAddress

Name

Description

address

Type: string

Example: example

lat

Type: number

locality

Type: string

Example: example

long

Type: number

province

Type: string

Example: example
Example
{
  "address": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "province": "example"
}

FlightGetListForForwarderNodalPointShipmentPeriod

Name

Description

from

Type: TimestampTZOutput

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

to
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
Example
{
  "from": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "to": null
}

FlightGetListForForwarderNodalPointShipment

Name

Description

content

Type: string

Содержимое разгрузки/погрузки.

Example: example

country

Type: string

Страна разгрузки/погрузки.

Example: example

id

Type: string

Example: example

name

Type: string

Название разгрузки/погрузки.

Example: example

npGeoAddress
All of 1 type

Геоадрес разгрузки/погрузки.

Example
{
  "address": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "province": "example"
}

npLegalType

Type: string

Юридический тип разгрузки/погрузки.

Example: example

npTin

Type: string

ИНН разгрузки/погрузки.

Example: example

period
All of 1 type

Период разгрузки/погрузки. если в периоде, не заполнено поле to, то считаем не периодом, а точной датой

Example
{
  "from": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "to": null
}

position

Type: integer

очередь разгрузки/погрузки.

addressComment

Type: string | null

Комментарий к адресу

Example: example

legalAddress

Type: string | null

юридический адрес компании которая производит разгрузку/погрузку

Example: example

legalPhone

Type: string | null

Example: example

npAdditionalContact

Type: FlightGetListForForwarderNodalPointAdditionalContact[] | null

Дополнительные контакты разгрузки/погрузки.

Example
[
  {
    "id": "example",
    "npcExternalId": "example",
    "npcName": "example",
    "npcPhone": "example"
  }
]

npShipmentId

Type: string | null

Идентификатор разгрузки/погрузки.

Example: example
Example
{
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "id": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "province": "example"
  },
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "to": null
  },
  "position": 0
}

FlightGetListForForwarderAdditionalConditions

Name

Description

externalOrderID

Type: string | null

Example: example
Example
{
  "externalOrderID": "example"
}

FlightGetListForForwarderCargoCategory

Name

Description

category

Type: string

Тип груза.

Example: example

categoryComment

Type: string

Коментарий к типу груза.

Example: example
Example
{
  "category": "example",
  "categoryComment": "example"
}

FlightGetListForForwarderCustomer

Name

Description

customerAddress

Type: string

адрес заказчика

Example: example

customerCountry

Type: string

страна заказчика

Example: example

customerName

Type: string

Имя контактного лица заказчика перевозки.

Example: example

customerPhone

Type: string

Телефон контактного лица заказчика перевозки.

Example: example

customerTin

Type: string

ИНН / БИН или другой уникальный налоговый номер
компании - заказчика перевозки.

Example: example

id

Type: string

Example: example

customerCargoPrice

Type: number | null

стоимость груза в блоке заказчика

customerLegalForm

Type: string | null

юридическая форма организации (OOO,ИП др)

Example: example
Example
{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerCountry": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example",
  "id": "example"
}

FlightGetListForForwarderDimensions

Name

Description

weight

Type: number

Вес в КГ.

breadth

Type: number | null

Ширина с точностью до 2х знактов.

height

Type: number | null

Высота с точностью до 2х знактов.

length

Type: number | null

Длина с точностью до 2х знактов.

pallet_count

Type: integer | null

Количество палет.

volume

Type: number | null

Объём с точностью до 3х знактов.
Example
{
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "pallet_count": 0,
  "volume": 0.5,
  "weight": 0.5
}

FlightGetListForForwarderPartner

Name

Description

id

Type: string

Example: example

tin

Type: string

Example: example
Example
{
  "id": "example",
  "tin": "example"
}

FlightGetListForForwarderDistribution

Name

Description

comment

Type: string

Комментарий, например, "какие-то условия"

Example: example

currency

Type: string

Валюта, например, "rub"

Example: example

dayDocClose

Type: integer

Количество дней до закрытия документа, например, 2

dayDocDelay

Type: integer

Количество дней задержки документа, например, 3

docFormat

Type: string

формат предоставления

Example: example

publicMatcher

Type: boolean

открытый аукцион или нет

type

Type: string

Тип определения исполнителя, например, "Отправить в свои заказы"

Example: example

typeDocClose

Type: string

Тип документа для закрытия, например, "bankdays"

Example: example

typeDocDelay

Type: string

Тип документа для задержки, например, "bankdays"

Example: example

amount

Type: number | null

Заявленная стоимость торгов (Сумма, например, 123)

partners

Type: FlightGetListForForwarderPartner[] | null

Исполнители (ТОЛЬКО в которых можно участвовать)

Example
[
  {
    "id": "example",
    "tin": "example"
  }
]
Example
{
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "partners": [
    {
      "id": "example",
      "tin": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

FlightGetListForForwarderPaymentDelayPeriod

Name

Description

paymentType

Type: string

Тип оплаты.

Example: example

daysDelayPeriod

Type: integer | null

Количество дней отсрочки платяжа.

postPayCalendarType

Type: string | null

Тип постоплаты.

Example: example
Example
{
  "daysDelayPeriod": 0,
  "paymentType": "example",
  "postPayCalendarType": "example"
}

FlightGetListForForwarderTemperatureRegime

Name

Description

from

Type: integer

Температура градусов в цельсиях, минимум.

to

Type: integer

Температура градусов в цельсиях, максимум.
Example
{
  "from": 0,
  "to": 0
}

FlightGetListForForwarderPrice

Name

Description

currency

Type: string

Валюта.

Example: example

price

Type: number

Цена с точностью до 2х знаков.
Example
{
  "currency": "example",
  "price": 0.5
}

FlightGetListForForwarderOrderInfo

Name

Description

bodyTypeComment

Type: string

Комментарий к типу кузова.

Example: example

cargoCategory
All of 1 type

Категория груза.

Example
{
  "category": "example",
  "categoryComment": "example"
}

currency

Type: string

Example: example

customer
All of 1 type

  • Type: FlightGetListForForwarderCustomer

    Example
    {
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerCountry": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example",
  "id": "example"
}

Инфорация о перевозке.

Example
{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerCountry": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example",
  "id": "example"
}

forwarder
All of 1 type

Сведения о заказчике

Example
{
  "id": "example",
  "isUnverified": true,
  "name": "example",
  "tin": "example"
}

orderId

Type: string

Example: example

orderStatus

Type: string

Example: example

transferOrderType

Type: string

FTL LTL

Example: example

additionalConditions
Any of 2 types
Example
{
  "externalOrderID": "example"
}

bodyType

Type: string[] | null

Тип кузова.

Example
[
  "example"
]

cargoId

Type: string | null

Example: example

dimensions
Any of 2 types

  • Type: FlightGetListForForwarderDimensions

    Example
    {
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "pallet_count": 0,
  "volume": 0.5,
  "weight": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}

Вес и объём.

Example
{
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "pallet_count": 0,
  "volume": 0.5,
  "weight": 0.5
}

distribution
Any of 2 types

  • Type: FlightGetListForForwarderDistribution

    Example
    {
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "partners": [
    {
      "id": "example",
      "tin": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "amount": 0.5,
  "comment": "example",
  "currency": "example",
  "dayDocClose": 0,
  "dayDocDelay": 0,
  "docFormat": "example",
  "partners": [
    {
      "id": "example",
      "tin": "example"
    }
  ],
  "publicMatcher": true,
  "type": "example",
  "typeDocClose": "example",
  "typeDocDelay": "example"
}

execResponsibleLogistician
Any of 2 types

  • Type: TimestampTZOutputContact

    Example
    {
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

fwdResponsibleLogistician
Any of 2 types

  • Type: TimestampTZOutputContact

    Example
    {
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

paymentDelayPeriod
Any of 2 types

Отсрочка платежа.

Example
{
  "daysDelayPeriod": 0,
  "paymentType": "example",
  "postPayCalendarType": "example"
}

responsibleCustomer
Any of 2 types

  • Type: TimestampTZOutputContact

    Example
    {
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

temperatureRegime

Type: FlightGetListForForwarderTemperatureRegime[] | null

Температурный режим.

Example
[
  {
    "from": 0,
    "to": 0
  }
]

transferOrderAdditionalConditions

Type: string | null

Дополнительные условия заказа.

Example: example

transferOrderCost
Any of 2 types

Стоимость заказа.

Example
{
  "currency": "example",
  "price": 0.5
}

transferOrderName

Type: string | null

Отображаемое имя заказа на перевозку.

Example: example

transshipmentTypes

Type: string[] | null

Тип загрузки и выгрузки.

Example
[
  "example"
]

typePaymentAndTax

Type: string | null

Тип оплаты платежа.

Example: example
Example
{
  "additionalConditions": {
    "externalOrderID": "example"
  },
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoId": "example",
  "currency": "example",
  "customer": {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerCountry": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example",
    "id": "example"
  },
  "dimensions": {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "pallet_count": 0,
    "volume": 0.5,
    "weight": 0.5
  },
  "distribution": {
    "amount": 0.5,
    "comment": "example",
    "currency": "example",
    "dayDocClose": 0,
    "dayDocDelay": 0,
    "docFormat": "example",
    "partners": [
      {
        "id": "example",
        "tin": "example"
      }
    ],
    "publicMatcher": true,
    "type": "example",
    "typeDocClose": "example",
    "typeDocDelay": "example"
  },
  "execResponsibleLogistician": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "forwarder": {
    "id": "example",
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "fwdResponsibleLogistician": null,
  "orderId": "example",
  "orderStatus": "example",
  "paymentDelayPeriod": {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  },
  "responsibleCustomer": null,
  "temperatureRegime": [
    {
      "from": 0,
      "to": 0
    }
  ],
  "transferOrderAdditionalConditions": "example",
  "transferOrderCost": {
    "currency": "example",
    "price": 0.5
  },
  "transferOrderName": "example",
  "transferOrderType": "example",
  "transshipmentTypes": [
    "example"
  ],
  "typePaymentAndTax": "example"
}

FlightGetListForForwarderPackage

Name

Description

count

Type: integer

Количество

hazardClass

Type: string

класс опасности

Example: example

isDeleted

Type: boolean

Помечен ли на удаление

packageId

Type: string

Example: example

packageName

Type: string

Отображаемое имя единицы товара.

Example: example

stackability

Type: string

стакающийся?

Example: example

amount

Type: number | null

Объявленная стоимость

capacity

Type: number | null

Объем

currency

Type: string | null

Валюта

Example: example

packageExternalId

Type: string | null

Идентификатор единицы товара со стороны заказчика.

Example: example

shipmentBodyType

Type: string | null

Тип упаковки груза.

Example: example

weight

Type: number | null

Вес
Example
{
  "amount": 0.5,
  "capacity": 0.5,
  "count": 0,
  "currency": "example",
  "hazardClass": "example",
  "isDeleted": true,
  "packageExternalId": "example",
  "packageId": "example",
  "packageName": "example",
  "shipmentBodyType": "example",
  "stackability": "example",
  "weight": 0.5
}

FlightGetListForForwarderShipment

Name

Description

flightTaskId

Type: string

Example: example

isDeleted

Type: boolean

Помечен ли на удаление

isRevoked

Type: boolean

Отозван ли из исполнения

name

Type: string

Example: example

npShipment

Type: FlightGetListForForwarderNodalPointShipment

Example
{
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "id": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "province": "example"
  },
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "to": null
  },
  "position": 0
}

npShipmentId

Type: string

Погрузка

Example: example

npUnshipment
All of 1 type

  • Type: FlightGetListForForwarderNodalPointShipment

    Example
    {
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "id": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "province": "example"
  },
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "to": null
  },
  "position": 0
}

Разгрузка

Example
{
  "addressComment": "example",
  "content": "example",
  "country": "example",
  "id": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "npAdditionalContact": [
    {
      "id": "example",
      "npcExternalId": "example",
      "npcName": "example",
      "npcPhone": "example"
    }
  ],
  "npGeoAddress": {
    "address": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "province": "example"
  },
  "npLegalType": "example",
  "npShipmentId": "example",
  "npTin": "example",
  "period": {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "to": null
  },
  "position": 0
}

packageType

Type: string

Example: example

shipmentId

Type: string

Example: example

taskStatus

Type: string

Example: example

transferOrderTaskID

Type: string

Example: example

comment

Type: string | null

Комментарий к грузу

Example: example

flightInfo
Any of 2 types

  • Type: FlightGetListForForwarderFlightTaskFlightInfo

    Example
    {
  "arrivalLoadingAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "arrivalUnloadingAt": null,
  "canSetCar": true,
  "canSetDriver": true,
  "canSetStatus": true,
  "carHeadInfo": {
    "bodyType": "example",
    "brand": "example",
    "createdAt": null,
    "documents": [
      {
        "expiration": null,
        "issueDate": null,
        "name": "example",
        "number": "example"
      }
    ],
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "imei": [
      "example"
    ],
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "orgIdAllowed": [
      "example"
    ],
    "ownerCountry": "example",
    "ownerId": "example",
    "ownerName": "example",
    "ownershipContactId": "example",
    "ownershipDetails": {
      "companyName": "example",
      "contractDate": null,
      "contractName": "example",
      "contractNumber": "example",
      "ownerTIN": "example",
      "ownerType": "example"
    },
    "ownershipType": "example",
    "palletCount": 0,
    "registrationCountry": "example",
    "type": "example",
    "vin": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "departureLoadingAt": null,
  "departureUnloadingAt": null,
  "driverInfo": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "endLoadingAt": null,
  "endUnloadingAt": null,
  "flightId": "example",
  "flightTaskId": "example",
  "flightTaskStatus": "example",
  "goToTheLoadingAt": null,
  "loadingOrder": 0,
  "startLoadingAt": null,
  "startUnloadingAt": null,
  "status": "example",
  "subStatus": "example",
  "trailerInfo": null,
  "unloadingOrder": 0
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "arrivalLoadingAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "arrivalUnloadingAt": null,
  "canSetCar": true,
  "canSetDriver": true,
  "canSetStatus": true,
  "carHeadInfo": {
    "bodyType": "example",
    "brand": "example",
    "createdAt": null,
    "documents": [
      {}
    ],
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "imei": [
      "example"
    ],
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "orgIdAllowed": [
      "example"
    ],
    "ownerCountry": "example",
    "ownerId": "example",
    "ownerName": "example",
    "ownershipContactId": "example",
    "ownershipDetails": {},
    "ownershipType": "example",
    "palletCount": 0,
    "registrationCountry": "example",
    "type": "example",
    "vin": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "departureLoadingAt": null,
  "departureUnloadingAt": null,
  "driverInfo": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "endLoadingAt": null,
  "endUnloadingAt": null,
  "flightId": "example",
  "flightTaskId": "example",
  "flightTaskStatus": "example",
  "goToTheLoadingAt": null,
  "loadingOrder": 0,
  "startLoadingAt": null,
  "startUnloadingAt": null,
  "status": "example",
  "subStatus": "example",
  "trailerInfo": null,
  "unloadingOrder": 0
}

orderInfo
Any of 2 types

  • Type: FlightGetListForForwarderOrderInfo

    Example
    {
  "additionalConditions": {
    "externalOrderID": "example"
  },
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoId": "example",
  "currency": "example",
  "customer": {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerCountry": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example",
    "id": "example"
  },
  "dimensions": {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "pallet_count": 0,
    "volume": 0.5,
    "weight": 0.5
  },
  "distribution": {
    "amount": 0.5,
    "comment": "example",
    "currency": "example",
    "dayDocClose": 0,
    "dayDocDelay": 0,
    "docFormat": "example",
    "partners": [
      {
        "id": "example",
        "tin": "example"
      }
    ],
    "publicMatcher": true,
    "type": "example",
    "typeDocClose": "example",
    "typeDocDelay": "example"
  },
  "execResponsibleLogistician": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "forwarder": {
    "id": "example",
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "fwdResponsibleLogistician": null,
  "orderId": "example",
  "orderStatus": "example",
  "paymentDelayPeriod": {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  },
  "responsibleCustomer": null,
  "temperatureRegime": [
    {
      "from": 0,
      "to": 0
    }
  ],
  "transferOrderAdditionalConditions": "example",
  "transferOrderCost": {
    "currency": "example",
    "price": 0.5
  },
  "transferOrderName": "example",
  "transferOrderType": "example",
  "transshipmentTypes": [
    "example"
  ],
  "typePaymentAndTax": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "additionalConditions": {
    "externalOrderID": "example"
  },
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoId": "example",
  "currency": "example",
  "customer": {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerCountry": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example",
    "id": "example"
  },
  "dimensions": {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "pallet_count": 0,
    "volume": 0.5,
    "weight": 0.5
  },
  "distribution": {
    "amount": 0.5,
    "comment": "example",
    "currency": "example",
    "dayDocClose": 0,
    "dayDocDelay": 0,
    "docFormat": "example",
    "partners": [
      {}
    ],
    "publicMatcher": true,
    "type": "example",
    "typeDocClose": "example",
    "typeDocDelay": "example"
  },
  "execResponsibleLogistician": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "forwarder": {
    "id": "example",
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "fwdResponsibleLogistician": null,
  "orderId": "example",
  "orderStatus": "example",
  "paymentDelayPeriod": {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  },
  "responsibleCustomer": null,
  "temperatureRegime": [
    {
      "from": 0,
      "to": 0
    }
  ],
  "transferOrderAdditionalConditions": "example",
  "transferOrderCost": {
    "currency": "example",
    "price": 0.5
  },
  "transferOrderName": "example",
  "transferOrderType": "example",
  "transshipmentTypes": [
    "example"
  ],
  "typePaymentAndTax": "example"
}

packages

Type: FlightGetListForForwarderPackage[] | null

Example
[
  {
    "amount": 0.5,
    "capacity": 0.5,
    "count": 0,
    "currency": "example",
    "hazardClass": "example",
    "isDeleted": true,
    "packageExternalId": "example",
    "packageId": "example",
    "packageName": "example",
    "shipmentBodyType": "example",
    "stackability": "example",
    "weight": 0.5
  }
]

revokedAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}

Когда был отозван

Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
Example
{
  "comment": "example",
  "flightInfo": {
    "arrivalLoadingAt": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "arrivalUnloadingAt": null,
    "canSetCar": true,
    "canSetDriver": true,
    "canSetStatus": true,
    "carHeadInfo": {
      "bodyType": "example",
      "brand": "example",
      "createdAt": null,
      "documents": [
        null
      ],
      "height": 0.5,
      "hydroBort": true,
      "id": "example",
      "imei": [
        null
      ],
      "length": 0.5,
      "loadCapacity": 0.5,
      "model": "example",
      "number": "example",
      "orgIdAllowed": [
        null
      ],
      "ownerCountry": "example",
      "ownerId": "example",
      "ownerName": "example",
      "ownershipContactId": "example",
      "ownershipDetails": null,
      "ownershipType": "example",
      "palletCount": 0,
      "registrationCountry": "example",
      "type": "example",
      "vin": "example",
      "volume": 0.5,
      "width": 0.5
    },
    "departureLoadingAt": null,
    "departureUnloadingAt": null,
    "driverInfo": {
      "id": "example",
      "isActual": true,
      "masked_phone": "example",
      "name": "example"
    },
    "endLoadingAt": null,
    "endUnloadingAt": null,
    "flightId": "example",
    "flightTaskId": "example",
    "flightTaskStatus": "example",
    "goToTheLoadingAt": null,
    "loadingOrder": 0,
    "startLoadingAt": null,
    "startUnloadingAt": null,
    "status": "example",
    "subStatus": "example",
    "trailerInfo": null,
    "unloadingOrder": 0
  },
  "flightTaskId": "example",
  "isDeleted": true,
  "isRevoked": true,
  "name": "example",
  "npShipment": {
    "addressComment": "example",
    "content": "example",
    "country": "example",
    "id": "example",
    "legalAddress": "example",
    "legalPhone": "example",
    "name": "example",
    "npAdditionalContact": [
      {
        "id": "example",
        "npcExternalId": "example",
        "npcName": "example",
        "npcPhone": "example"
      }
    ],
    "npGeoAddress": {
      "address": "example",
      "lat": 0.5,
      "locality": "example",
      "long": 0.5,
      "province": "example"
    },
    "npLegalType": "example",
    "npShipmentId": "example",
    "npTin": "example",
    "period": {
      "from": null,
      "to": null
    },
    "position": 0
  },
  "npShipmentId": "example",
  "npUnshipment": null,
  "orderInfo": {
    "additionalConditions": {
      "externalOrderID": "example"
    },
    "bodyType": [
      "example"
    ],
    "bodyTypeComment": "example",
    "cargoCategory": {
      "category": "example",
      "categoryComment": "example"
    },
    "cargoId": "example",
    "currency": "example",
    "customer": {
      "customerAddress": "example",
      "customerCargoPrice": 0.5,
      "customerCountry": "example",
      "customerLegalForm": "example",
      "customerName": "example",
      "customerPhone": "example",
      "customerTin": "example",
      "id": "example"
    },
    "dimensions": {
      "breadth": 0.5,
      "height": 0.5,
      "length": 0.5,
      "pallet_count": 0,
      "volume": 0.5,
      "weight": 0.5
    },
    "distribution": {
      "amount": 0.5,
      "comment": "example",
      "currency": "example",
      "dayDocClose": 0,
      "dayDocDelay": 0,
      "docFormat": "example",
      "partners": [
        null
      ],
      "publicMatcher": true,
      "type": "example",
      "typeDocClose": "example",
      "typeDocDelay": "example"
    },
    "execResponsibleLogistician": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "forwarder": {
      "id": "example",
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    },
    "fwdResponsibleLogistician": null,
    "orderId": "example",
    "orderStatus": "example",
    "paymentDelayPeriod": {
      "daysDelayPeriod": 0,
      "paymentType": "example",
      "postPayCalendarType": "example"
    },
    "responsibleCustomer": null,
    "temperatureRegime": [
      {
        "from": 0,
        "to": 0
      }
    ],
    "transferOrderAdditionalConditions": "example",
    "transferOrderCost": {
      "currency": "example",
      "price": 0.5
    },
    "transferOrderName": "example",
    "transferOrderType": "example",
    "transshipmentTypes": [
      "example"
    ],
    "typePaymentAndTax": "example"
  },
  "packageType": "example",
  "packages": [
    {
      "amount": 0.5,
      "capacity": 0.5,
      "count": 0,
      "currency": "example",
      "hazardClass": "example",
      "isDeleted": true,
      "packageExternalId": "example",
      "packageId": "example",
      "packageName": "example",
      "shipmentBodyType": "example",
      "stackability": "example",
      "weight": 0.5
    }
  ],
  "revokedAt": null,
  "shipmentId": "example",
  "taskStatus": "example",
  "transferOrderTaskID": "example"
}

FlightGetListForForwarderFlight

Name

Description

canSetCar

Type: boolean

canSetDriver

Type: boolean

canSetStatus

Type: boolean

executer

Type: FlightGetListForForwarderOrgInfo

Example
{
  "id": "example",
  "isUnverified": true,
  "name": "example",
  "tin": "example"
}

executerId

Type: string

Example: example

extId

Type: string

Example: example

flightName

Type: string

Example: example

id

Type: string

Example: example

isForwardingCompany

Type: boolean

status

Type: string

Example: example

subStatus

Type: string

Example: example

alerts

Type: FlightGetListForForwarderAlertInfo[] | null

Alerts Яркие уведомления

Example
[
  {
    "alertType": "example",
    "description": "example"
  }
]

canceledAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

completedAt
Any of 2 types

  • Type: TimestampTZOutput

    Example
    {
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}

driver
Any of 2 types

  • Type: FlightGetListForForwarderDriverInfo

    Example
    {
  "id": "example",
  "isActual": true,
  "masked_phone": "example",
  "name": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "id": "example",
  "isActual": true,
  "masked_phone": "example",
  "name": "example"
}

externalExecutor
Any of 2 types

  • Type: FlightGetListForForwarderExternalExecutor

    Example
    {
  "contactEmail": "example",
  "contactName": "example",
  "contactPhone": "example",
  "country": "example",
  "legalAddress": "example",
  "name": "example",
  "orgType": "example",
  "tin": "example",
  "vat": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "contactEmail": "example",
  "contactName": "example",
  "contactPhone": "example",
  "country": "example",
  "legalAddress": "example",
  "name": "example",
  "orgType": "example",
  "tin": "example",
  "vat": 0.5
}

flightWay
Any of 2 types

  • Type: FlightGetListForForwarderFlightWay

    Example
    {
  "archivedAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "createdAt": null,
  "generationType": "example",
  "id": "example",
  "updatedAt": null,
  "visits": [
    {
      "actions": [
        {
          "actionId": "example",
          "actionType": "example",
          "orderInVisit": 0,
          "relation": null
        }
      ],
      "endAt": null,
      "id": "example",
      "orderInWay": 0,
      "startAt": null,
      "wayPoint": {
        "address": "example",
        "addressComment": "example",
        "id": "example",
        "lat": 0.5,
        "locality": "example",
        "long": 0.5,
        "name": "example",
        "province": "example",
        "tin": "example"
      }
    }
  ]
}

  • Type: object | null

    Const: null

    Example
    {}

Версия связанного маршрута заказа. Заполняется асинхронно, может ссылаться на заархивированную версию

Example
{
  "archivedAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "createdAt": null,
  "generationType": "example",
  "id": "example",
  "updatedAt": null,
  "visits": [
    {
      "actions": [
        {}
      ],
      "endAt": null,
      "id": "example",
      "orderInWay": 0,
      "startAt": null,
      "wayPoint": {}
    }
  ]
}

responsibleLogistician
Any of 2 types

  • Type: TimestampTZOutputContact

    Example
    {
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "name": "example",
  "orgId": "example",
  "orgName": "example",
  "orgTin": "example",
  "publicEmail": "example",
  "publicPhone": "example",
  "type": "example",
  "value": "example"
}

tasks

Type: FlightGetListForForwarderShipment[] | null

Example
[
  {
    "comment": "example",
    "flightInfo": {
      "arrivalLoadingAt": {},
      "arrivalUnloadingAt": null,
      "canSetCar": true,
      "canSetDriver": true,
      "canSetStatus": true,
      "carHeadInfo": {},
      "departureLoadingAt": null,
      "departureUnloadingAt": null,
      "driverInfo": {},
      "endLoadingAt": null,
      "endUnloadingAt": null,
      "flightId": "example",
      "flightTaskId": "example",
      "flightTaskStatus": "example",
      "goToTheLoadingAt": null,
      "loadingOrder": 0,
      "startLoadingAt": null,
      "startUnloadingAt": null,
      "status": "example",
      "subStatus": "example",
      "trailerInfo": null,
      "unloadingOrder": 0
    },
    "flightTaskId": "example",
    "isDeleted": true,
    "isRevoked": true,
    "name": "example",
    "npShipment": {
      "addressComment": "example",
      "content": "example",
      "country": "example",
      "id": "example",
      "legalAddress": "example",
      "legalPhone": "example",
      "name": "example",
      "npAdditionalContact": [
        {
          "id": "example",
          "npcExternalId": "example",
          "npcName": "example",
          "npcPhone": "example"
        }
      ],
      "npGeoAddress": {
        "address": "example",
        "lat": 0.5,
        "locality": "example",
        "long": 0.5,
        "province": "example"
      },
      "npLegalType": "example",
      "npShipmentId": "example",
      "npTin": "example",
      "period": {
        "from": null,
        "to": null
      },
      "position": 0
    },
    "npShipmentId": "example",
    "npUnshipment": null,
    "orderInfo": {
      "additionalConditions": {},
      "bodyType": [
        "example"
      ],
      "bodyTypeComment": "example",
      "cargoCategory": null,
      "cargoId": "example",
      "currency": "example",
      "customer": null,
      "dimensions": {},
      "distribution": {},
      "execResponsibleLogistician": {},
      "forwarder": null,
      "fwdResponsibleLogistician": null,
      "orderId": "example",
      "orderStatus": "example",
      "paymentDelayPeriod": {},
      "responsibleCustomer": null,
      "temperatureRegime": [
        {}
      ],
      "transferOrderAdditionalConditions": "example",
      "transferOrderCost": {},
      "transferOrderName": "example",
      "transferOrderType": "example",
      "transshipmentTypes": [
        "example"
      ],
      "typePaymentAndTax": "example"
    },
    "packageType": "example",
    "packages": [
      {
        "amount": 0.5,
        "capacity": 0.5,
        "count": 0,
        "currency": "example",
        "hazardClass": "example",
        "isDeleted": true,
        "packageExternalId": "example",
        "packageId": "example",
        "packageName": "example",
        "shipmentBodyType": "example",
        "stackability": "example",
        "weight": 0.5
      }
    ],
    "revokedAt": null,
    "shipmentId": "example",
    "taskStatus": "example",
    "transferOrderTaskID": "example"
  }
]

trailer
Any of 2 types

  • Type: FlightGetListForForwarderCarInfo

    Example
    {
  "bodyType": "example",
  "brand": "example",
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "documents": [
    {
      "expiration": null,
      "issueDate": null,
      "name": "example",
      "number": "example"
    }
  ],
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "imei": [
    "example"
  ],
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "orgIdAllowed": [
    "example"
  ],
  "ownerCountry": "example",
  "ownerId": "example",
  "ownerName": "example",
  "ownershipContactId": "example",
  "ownershipDetails": {
    "companyName": "example",
    "contractDate": null,
    "contractName": "example",
    "contractNumber": "example",
    "ownerTIN": "example",
    "ownerType": "example"
  },
  "ownershipType": "example",
  "palletCount": 0,
  "registrationCountry": "example",
  "type": "example",
  "vin": "example",
  "volume": 0.5,
  "width": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "bodyType": "example",
  "brand": "example",
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "documents": [
    {
      "expiration": null,
      "issueDate": null,
      "name": "example",
      "number": "example"
    }
  ],
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "imei": [
    "example"
  ],
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "orgIdAllowed": [
    "example"
  ],
  "ownerCountry": "example",
  "ownerId": "example",
  "ownerName": "example",
  "ownershipContactId": "example",
  "ownershipDetails": {
    "companyName": "example",
    "contractDate": null,
    "contractName": "example",
    "contractNumber": "example",
    "ownerTIN": "example",
    "ownerType": "example"
  },
  "ownershipType": "example",
  "palletCount": 0,
  "registrationCountry": "example",
  "type": "example",
  "vin": "example",
  "volume": 0.5,
  "width": 0.5
}

truck
Any of 2 types

  • Type: FlightGetListForForwarderCarInfo

    Example
    {
  "bodyType": "example",
  "brand": "example",
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "documents": [
    {
      "expiration": null,
      "issueDate": null,
      "name": "example",
      "number": "example"
    }
  ],
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "imei": [
    "example"
  ],
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "orgIdAllowed": [
    "example"
  ],
  "ownerCountry": "example",
  "ownerId": "example",
  "ownerName": "example",
  "ownershipContactId": "example",
  "ownershipDetails": {
    "companyName": "example",
    "contractDate": null,
    "contractName": "example",
    "contractNumber": "example",
    "ownerTIN": "example",
    "ownerType": "example"
  },
  "ownershipType": "example",
  "palletCount": 0,
  "registrationCountry": "example",
  "type": "example",
  "vin": "example",
  "volume": 0.5,
  "width": 0.5
}

  • Type: object | null

    Const: null

    Example
    {}
Example
{
  "bodyType": "example",
  "brand": "example",
  "createdAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "documents": [
    {
      "expiration": null,
      "issueDate": null,
      "name": "example",
      "number": "example"
    }
  ],
  "height": 0.5,
  "hydroBort": true,
  "id": "example",
  "imei": [
    "example"
  ],
  "length": 0.5,
  "loadCapacity": 0.5,
  "model": "example",
  "number": "example",
  "orgIdAllowed": [
    "example"
  ],
  "ownerCountry": "example",
  "ownerId": "example",
  "ownerName": "example",
  "ownershipContactId": "example",
  "ownershipDetails": {
    "companyName": "example",
    "contractDate": null,
    "contractName": "example",
    "contractNumber": "example",
    "ownerTIN": "example",
    "ownerType": "example"
  },
  "ownershipType": "example",
  "palletCount": 0,
  "registrationCountry": "example",
  "type": "example",
  "vin": "example",
  "volume": 0.5,
  "width": 0.5
}
Example
{
  "alerts": [
    {
      "alertType": "example",
      "description": "example"
    }
  ],
  "canSetCar": true,
  "canSetDriver": true,
  "canSetStatus": true,
  "canceledAt": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "completedAt": null,
  "driver": {
    "id": "example",
    "isActual": true,
    "masked_phone": "example",
    "name": "example"
  },
  "executer": {
    "id": "example",
    "isUnverified": true,
    "name": "example",
    "tin": "example"
  },
  "executerId": "example",
  "extId": "example",
  "externalExecutor": {
    "contactEmail": "example",
    "contactName": "example",
    "contactPhone": "example",
    "country": "example",
    "legalAddress": "example",
    "name": "example",
    "orgType": "example",
    "tin": "example",
    "vat": 0.5
  },
  "flightName": "example",
  "flightWay": {
    "archivedAt": null,
    "createdAt": null,
    "generationType": "example",
    "id": "example",
    "updatedAt": null,
    "visits": [
      {
        "actions": [
          null
        ],
        "endAt": null,
        "id": "example",
        "orderInWay": 0,
        "startAt": null,
        "wayPoint": null
      }
    ]
  },
  "id": "example",
  "isForwardingCompany": true,
  "responsibleLogistician": {
    "name": "example",
    "orgId": "example",
    "orgName": "example",
    "orgTin": "example",
    "publicEmail": "example",
    "publicPhone": "example",
    "type": "example",
    "value": "example"
  },
  "status": "example",
  "subStatus": "example",
  "tasks": [
    {
      "comment": "example",
      "flightInfo": {
        "arrivalLoadingAt": null,
        "arrivalUnloadingAt": null,
        "canSetCar": true,
        "canSetDriver": true,
        "canSetStatus": true,
        "carHeadInfo": null,
        "departureLoadingAt": null,
        "departureUnloadingAt": null,
        "driverInfo": null,
        "endLoadingAt": null,
        "endUnloadingAt": null,
        "flightId": "example",
        "flightTaskId": "example",
        "flightTaskStatus": "example",
        "goToTheLoadingAt": null,
        "loadingOrder": 0,
        "startLoadingAt": null,
        "startUnloadingAt": null,
        "status": "example",
        "subStatus": "example",
        "trailerInfo": null,
        "unloadingOrder": 0
      },
      "flightTaskId": "example",
      "isDeleted": true,
      "isRevoked": true,
      "name": "example",
      "npShipment": {
        "addressComment": "example",
        "content": "example",
        "country": "example",
        "id": "example",
        "legalAddress": "example",
        "legalPhone": "example",
        "name": "example",
        "npAdditionalContact": [
          {}
        ],
        "npGeoAddress": null,
        "npLegalType": "example",
        "npShipmentId": "example",
        "npTin": "example",
        "period": null,
        "position": 0
      },
      "npShipmentId": "example",
      "npUnshipment": null,
      "orderInfo": {
        "additionalConditions": null,
        "bodyType": [
          null
        ],
        "bodyTypeComment": "example",
        "cargoCategory": null,
        "cargoId": "example",
        "currency": "example",
        "customer": null,
        "dimensions": null,
        "distribution": null,
        "execResponsibleLogistician": null,
        "forwarder": null,
        "fwdResponsibleLogistician": null,
        "orderId": "example",
        "orderStatus": "example",
        "paymentDelayPeriod": null,
        "responsibleCustomer": null,
        "temperatureRegime": [
          null
        ],
        "transferOrderAdditionalConditions": "example",
        "transferOrderCost": null,
        "transferOrderName": "example",
        "transferOrderType": "example",
        "transshipmentTypes": [
          null
        ],
        "typePaymentAndTax": "example"
      },
      "packageType": "example",
      "packages": [
        {
          "amount": 0.5,
          "capacity": 0.5,
          "count": 0,
          "currency": "example",
          "hazardClass": "example",
          "isDeleted": true,
          "packageExternalId": "example",
          "packageId": "example",
          "packageName": "example",
          "shipmentBodyType": "example",
          "stackability": "example",
          "weight": 0.5
        }
      ],
      "revokedAt": null,
      "shipmentId": "example",
      "taskStatus": "example",
      "transferOrderTaskID": "example"
    }
  ],
  "trailer": {
    "bodyType": "example",
    "brand": "example",
    "createdAt": null,
    "documents": [
      {
        "expiration": null,
        "issueDate": null,
        "name": "example",
        "number": "example"
      }
    ],
    "height": 0.5,
    "hydroBort": true,
    "id": "example",
    "imei": [
      "example"
    ],
    "length": 0.5,
    "loadCapacity": 0.5,
    "model": "example",
    "number": "example",
    "orgIdAllowed": [
      "example"
    ],
    "ownerCountry": "example",
    "ownerId": "example",
    "ownerName": "example",
    "ownershipContactId": "example",
    "ownershipDetails": {
      "companyName": "example",
      "contractDate": null,
      "contractName": "example",
      "contractNumber": "example",
      "ownerTIN": "example",
      "ownerType": "example"
    },
    "ownershipType": "example",
    "palletCount": 0,
    "registrationCountry": "example",
    "type": "example",
    "vin": "example",
    "volume": 0.5,
    "width": 0.5
  },
  "truck": null
}

FlightGetListForForwarderResponse

Name

Description

flights

Type: FlightGetListForForwarderFlight[] | null

Example
[
  {
    "alerts": [
      {
        "alertType": "example",
        "description": "example"
      }
    ],
    "canSetCar": true,
    "canSetDriver": true,
    "canSetStatus": true,
    "canceledAt": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "completedAt": null,
    "driver": {
      "id": "example",
      "isActual": true,
      "masked_phone": "example",
      "name": "example"
    },
    "executer": {
      "id": "example",
      "isUnverified": true,
      "name": "example",
      "tin": "example"
    },
    "executerId": "example",
    "extId": "example",
    "externalExecutor": {
      "contactEmail": "example",
      "contactName": "example",
      "contactPhone": "example",
      "country": "example",
      "legalAddress": "example",
      "name": "example",
      "orgType": "example",
      "tin": "example",
      "vat": 0.5
    },
    "flightName": "example",
    "flightWay": {
      "archivedAt": null,
      "createdAt": null,
      "generationType": "example",
      "id": "example",
      "updatedAt": null,
      "visits": [
        {}
      ]
    },
    "id": "example",
    "isForwardingCompany": true,
    "responsibleLogistician": {
      "name": "example",
      "orgId": "example",
      "orgName": "example",
      "orgTin": "example",
      "publicEmail": "example",
      "publicPhone": "example",
      "type": "example",
      "value": "example"
    },
    "status": "example",
    "subStatus": "example",
    "tasks": [
      {
        "comment": "example",
        "flightInfo": {},
        "flightTaskId": "example",
        "isDeleted": true,
        "isRevoked": true,
        "name": "example",
        "npShipment": {
          "addressComment": "example",
          "content": "example",
          "country": "example",
          "id": "example",
          "legalAddress": "example",
          "legalPhone": "example",
          "name": "example",
          "npAdditionalContact": [
            null
          ],
          "npGeoAddress": null,
          "npLegalType": "example",
          "npShipmentId": "example",
          "npTin": "example",
          "period": null,
          "position": 0
        },
        "npShipmentId": "example",
        "npUnshipment": null,
        "orderInfo": {},
        "packageType": "example",
        "packages": [
          {}
        ],
        "revokedAt": null,
        "shipmentId": "example",
        "taskStatus": "example",
        "transferOrderTaskID": "example"
      }
    ],
    "trailer": {
      "bodyType": "example",
      "brand": "example",
      "createdAt": null,
      "documents": [
        {}
      ],
      "height": 0.5,
      "hydroBort": true,
      "id": "example",
      "imei": [
        "example"
      ],
      "length": 0.5,
      "loadCapacity": 0.5,
      "model": "example",
      "number": "example",
      "orgIdAllowed": [
        "example"
      ],
      "ownerCountry": "example",
      "ownerId": "example",
      "ownerName": "example",
      "ownershipContactId": "example",
      "ownershipDetails": {},
      "ownershipType": "example",
      "palletCount": 0,
      "registrationCountry": "example",
      "type": "example",
      "vin": "example",
      "volume": 0.5,
      "width": 0.5
    },
    "truck": null
  }
]
Example
{
  "flights": [
    {
      "alerts": [
        {
          "alertType": "example",
          "description": "example"
        }
      ],
      "canSetCar": true,
      "canSetDriver": true,
      "canSetStatus": true,
      "canceledAt": {
        "displayTZ": "+03:00",
        "time": "2020-01-01T00:00:00"
      },
      "completedAt": null,
      "driver": {
        "id": "example",
        "isActual": true,
        "masked_phone": "example",
        "name": "example"
      },
      "executer": {
        "id": "example",
        "isUnverified": true,
        "name": "example",
        "tin": "example"
      },
      "executerId": "example",
      "extId": "example",
      "externalExecutor": {
        "contactEmail": "example",
        "contactName": "example",
        "contactPhone": "example",
        "country": "example",
        "legalAddress": "example",
        "name": "example",
        "orgType": "example",
        "tin": "example",
        "vat": 0.5
      },
      "flightName": "example",
      "flightWay": {
        "archivedAt": null,
        "createdAt": null,
        "generationType": "example",
        "id": "example",
        "updatedAt": null,
        "visits": [
          null
        ]
      },
      "id": "example",
      "isForwardingCompany": true,
      "responsibleLogistician": {
        "name": "example",
        "orgId": "example",
        "orgName": "example",
        "orgTin": "example",
        "publicEmail": "example",
        "publicPhone": "example",
        "type": "example",
        "value": "example"
      },
      "status": "example",
      "subStatus": "example",
      "tasks": [
        {
          "comment": "example",
          "flightInfo": null,
          "flightTaskId": "example",
          "isDeleted": true,
          "isRevoked": true,
          "name": "example",
          "npShipment": {},
          "npShipmentId": "example",
          "npUnshipment": null,
          "orderInfo": null,
          "packageType": "example",
          "packages": [
            null
          ],
          "revokedAt": null,
          "shipmentId": "example",
          "taskStatus": "example",
          "transferOrderTaskID": "example"
        }
      ],
      "trailer": {
        "bodyType": "example",
        "brand": "example",
        "createdAt": null,
        "documents": [
          null
        ],
        "height": 0.5,
        "hydroBort": true,
        "id": "example",
        "imei": [
          null
        ],
        "length": 0.5,
        "loadCapacity": 0.5,
        "model": "example",
        "number": "example",
        "orgIdAllowed": [
          null
        ],
        "ownerCountry": "example",
        "ownerId": "example",
        "ownerName": "example",
        "ownershipContactId": "example",
        "ownershipDetails": null,
        "ownershipType": "example",
        "palletCount": 0,
        "registrationCountry": "example",
        "type": "example",
        "vin": "example",
        "volume": 0.5,
        "width": 0.5
      },
      "truck": null
    }
  ]
}

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"
}
Предыдущая
Получить рейсы исполнителя
Следующая
Найти координаты по адресу