- Назначение
- Request
- Responses
- 200 OK
- Body
- FlightListForExecutorV1AlertInfo
- TimestampTZOutput
- FlightListForExecutorV1DriverInfoForExecutorFlightList
- FlightListForExecutorV1OrgInfoForExecutor
- FlightListForExecutorV1ExternalExecutor
- FlightListForExecutorV1DocumentsDelay
- FlightListForExecutorV1ExternalExecutorConditions
- FlightListForExecutorV1FlightWayActionRelation
- FlightListForExecutorV1FlightWayAction
- FlightListForExecutorV1FlightWayPoint
- FlightListForExecutorV1FlightWayVisit
- FlightListForExecutorV1FlightWay
- TimestampTZOutputContact
- FlightListForExecutorV1Document
- FlightListForExecutorV1OwnershipDetails
- FlightListForExecutorV1CarInfoForExecutor
- FlightListForExecutorV1FlightTaskFlightInfo
- FlightListForExecutorV1NodalPointAdditionalContact
- FlightListForExecutorV1NpGeoAddress
- FlightListForExecutorV1NodalPointShipmentPeriod
- FlightListForExecutorV1NodalPointShipment
- FlightListForExecutorV1CargoCategory
- FlightListForExecutorV1Customer
- FlightListForExecutorV1Dimensions
- FlightListForExecutorV1Partner
- FlightListForExecutorV1Distribution
- FlightListForExecutorV1PaymentDelayPeriod
- FlightListForExecutorV1TemperatureRegime
- FlightListForExecutorV1Price
- FlightListForExecutorV1OrderInfo
- FlightListForExecutorV1Package
- FlightListForExecutorV1Shipment
- FlightListForExecutorV1Flight
- FlightListForExecutorV1Response
- 400 Bad Request
- 403 Forbidden
- 500 Internal Server Error
Получить рейсы исполнителя
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Получите актуальные карточки рейсов. Для чтения нужно право flight_get_task. Передайте непустой список идентификаторов в data.ids и найдите записи в data.flights по id. Оставляйте полные карточки с контактами, адресами и другими чувствительными данными в клиенте.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
POST
https://partner-test-yamagistrali.ru/api/flights/v1/listForExecutor
Тестовый стенд
Body
application/json
{
"data": {
"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"
],
"fromChooseWinnerTS": null,
"fromCreateTS": null,
"fromLoadingTS": null,
"fromUnloadingTS": null,
"fromUpdateTS": null,
"fwdIds": [
"example"
],
"ids": [
"example"
],
"limit": 0,
"loadPoint": null,
"npFromAddress": [
"example"
],
"npShipmentIds": [
"example"
],
"npToAddress": [
"example"
],
"npUnshipmentIds": [
"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"
],
"toChooseWinnerTS": null,
"toCreateTS": null,
"toLoadingTS": null,
"toUnloadingTS": null,
"toUpdateTS": null,
"trailerIds": [
"example"
],
"truckIds": [
"example"
],
"unloadPoint": null
}
}
|
Name |
Description |
|
data |
Type: FlightListForExecutorV1Request Example
|
FlightSearchEdmFilter
|
Name |
Description |
|
actionRequiredDocumentTypes |
Type: string[] | null ActionRequiredDocumentTypes ограничивает выдачу типами ЭПД, по которым ожидается действие от любого участника. Example
|
|
actionRequiredFromOrganizationIds |
Type: string[] | null ActionRequiredFromOrganizationIDs ограничивает выдачу рейсами, для которых действие с документом ожидается от указанных организаций. Example
|
|
documentIds |
Type: string[] | null DocumentIDs ограничивает выдачу рейсами с указанными идентификаторами документов ЭДО. Example
|
|
epeStatuses |
Type: string[] | null EpeStatuses ограничивает выдачу статусами документов EPE. Example
|
|
etrnStatuses |
Type: string[] | null EtrnStatuses ограничивает выдачу статусами документов ETRN. Example
|
|
exprStatuses |
Type: string[] | null ExprStatuses ограничивает выдачу статусами документов EXPR. Example
|
|
ezzStatuses |
Type: string[] | null EzzStatuses ограничивает выдачу статусами документов EZZ. 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: |
|
time |
Type: string<date-time> Example: |
|
useLocation |
Type: string Example: |
Example
{
"displayTZ": "+03:00",
"time": "2020-01-01T11:47:38+03:00",
"useLocation": "+05:00"
}
FlightSearchFilter
|
Name |
Description |
|
additionalConditionsExternalOrderID |
Type: string[] | null Example
|
|
bodyTypeComments |
Type: string[] | null Параметр "Комментарий к кузову" в разделе "Перевозка" создания заказа Example
|
|
carBodyType |
Type: string[] | null CarBodyType - Пусто == все Example
|
|
carBrand |
Type: string[] | null CarBrand - Пусто == все Example
|
|
cargoIds |
Type: string[] | null Example
|
|
carNumber |
Type: string[] | null CarNumber - Пусто == все Example
|
|
carType |
Type: string[] | null CarType - Пусто == все Example
|
|
customerIds |
Type: string[] | null Example
|
|
distributionComment |
Type: string[] | null Параметр "Особые условия перевозки" в разделе "Исполнители" создания заказа Example
|
|
driverIds |
Type: string[] | null DriverIDs - Пусто == все Example
|
|
driverPersonalIds |
Type: string[] | null Example
|
|
edm |
Any of 2 types
Example
|
|
etrnState |
Type: string[] | null Example
|
|
exactIds |
Type: string[] | null Example
|
|
executorIds |
Type: string[] | null IDs Не обязательноый параметр Example
|
|
externalExecutor |
Type: string[] | null Example
|
|
flightGeoAnalyzed |
Type: boolean | null Признак наличия геоданных по рейсу. Может быть true (должны быть), false (не должны быть) или null (не важно). Последнее значение выключает фильтр |
|
flightSubStatus |
Type: string[] | null Example
|
|
flightWayFirstLoadingWayPoint |
Any of 2 types
координаты и радиус первой погрузки маршрута рейса Example
|
|
flightWayFirstLoadingWayPointAddresses |
Type: string[] | null адреса первой погрузки маршрута рейса Example
|
|
flightWayLastUnloadingWayPoint |
Any of 2 types
координаты и радиус последней разгрузки маршрута рейса Example
|
|
flightWayLastUnloadingWayPointAddresses |
Type: string[] | null адреса последней разгрузки маршрута рейса Example
|
|
fromCreateTS |
Any of 2 types
FromCreateTS Не обязательноый параметр Example
|
|
fromFirstLoadTS |
Any of 2 types
Время первой погрузки. Example
|
|
fromFlightWayFirstLoadingWayPointStartAtTS |
Any of 2 types
дата, после которой которой начинается первая погрузка маршрута рейса Example
|
|
fromFlightWayLastUnloadingWayPointEndAtTS |
Any of 2 types
дата, после которой которой начинается последняя разгрузка маршрута рейса Example
|
|
fromLoadingTS |
Any of 2 types
Время погрузки. Example
|
|
fromUnloadingTS |
Any of 2 types
Время разгрузки. Example
|
|
fromUpdateTS |
Any of 2 types
ToCreateTS Не обязательноый параметр Example
|
|
fwdIds |
Type: string[] | null IDs Не обязательноый параметр Example
|
|
ids |
Type: string[] | null IDs Не обязательноый параметр Example
|
|
loadPoint |
Any of 2 types
LoadPoint - Пусто == все Example
|
|
npFromAddress |
Type: string[] | null Example
|
|
npShipmentIds |
Type: string[] | null Example
|
|
npToAddress |
Type: string[] | null Example
|
|
npUnshipmentIds |
Type: string[] | null Example
|
|
orderCargoComment |
Type: string[] | null Параметр "Комментарий для себя" в разделе "Перевозка" создания заказа Example
|
|
orderCargoIds |
Type: string[] | null Example
|
|
orderCustomerComment |
Type: string[] | null Параметр "Комментарий" в разделе "Владелец груза" создания заказа Example
|
|
orderIds |
Type: string[] | null OrderIDs Не обязательноый параметр Example
|
|
packageNames |
Type: string[] | null Example
|
|
partialIds |
Type: string[] | null Example
|
|
responsibleLogisticianByExecutor |
Type: string[] | null ResponsibleLogisticianByExecutor id-сотрудников ответсвенных логистов. - Пусто == все Example
|
|
responsibleLogisticianByForwarder |
Type: string[] | null ResponsibleLogisticianByForwarder id-сотрудников ответсвенных логистов. - Пусто == все Example
|
|
responsibleLogisticianForOrderByExecutor |
Type: string[] | null ResponsibleLogisticianForOrderByExecutor id-сотрудников ответсвенных за заказ логистов. - Пусто == все Example
|
|
responsibleLogisticianForOrderByForwarder |
Type: string[] | null ResponsibleLogisticianForOrderByForwarder id-сотрудников ответсвенных за заказ логистов. - Пусто == все Example
|
|
shipmentNames |
Type: string[] | null Example
|
|
states |
Type: string[] | null States Статусы рейса Не обязательноый параметр Example
|
|
toCreateTS |
Any of 2 types
ToCreateTS Не обязательноый параметр Example
|
|
toFirstLoadTS |
Any of 2 types
Example
|
|
toFlightWayFirstLoadingWayPointStartAtTS |
Any of 2 types
дата, до которой которой заканчивается первая погрузка маршрута рейса Example
|
|
toFlightWayLastUnloadingWayPointEndAtTS |
Any of 2 types
дата, до которой которой заканчивается последняя разгрузка маршрута рейса Example
|
|
toLoadingTS |
Any of 2 types
Время погрузки. Example
|
|
toUnloadingTS |
Any of 2 types
Время разгрузки. Example
|
|
toUpdateTS |
Any of 2 types
ToCreateTS Не обязательноый параметр Example
|
|
trailerIds |
Type: string[] | null TrailerIDs - Пусто == все Example
|
|
truckIds |
Type: string[] | null CarsIDs - Пусто == все Example
|
|
unloadPoint |
Any of 2 types
UnloadPoint - Пусто == все 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
}
FlightSearchSortSetting
|
Name |
Description |
|
field |
Type: string Example: |
|
order |
Type: string | null Example: |
Example
{
"field": "example",
"order": "example"
}
FlightSearchSort
|
Name |
Description |
|
sortSettings |
Type: FlightSearchSortSetting[] | null Example
|
Example
{
"sortSettings": [
{
"field": "example",
"order": "example"
}
]
}
FlightListForExecutorV1Request
|
Name |
Description |
|
carBodyType |
Type: string[] | null CarBodyType - Пусто == все Example
|
|
carBrand |
Type: string[] | null CarBrand - Пусто == все Example
|
|
cargoIds |
Type: string[] | null Example
|
|
carNumber |
Type: string[] | null CarNumber - Пусто == все Example
|
|
carType |
Type: string[] | null CarType - Пусто == все Example
|
|
customerIds |
Type: string[] | null Example
|
|
distributionComment |
Type: string[] | null Параметр "Особые условия перевозки" в разделе "Исполнители" создания заказа Example
|
|
driverIds |
Type: string[] | null DriverIDs - Пусто == все Example
|
|
exactIds |
Type: string[] | null Example
|
|
executorIds |
Type: string[] | null IDs Не обязательноый параметр Example
|
|
externalExecutor |
Type: string[] | null Example
|
|
filter |
Any of 2 types
Example
|
|
flightSubStatus |
Type: string[] | null Example
|
|
fromChooseWinnerTS |
Any of 2 types
Время определения победителя. Example
|
|
fromCreateTS |
Any of 2 types
FromCreateTS Не обязательноый параметр Example
|
|
fromLoadingTS |
Any of 2 types
Время погрузки. Example
|
|
fromUnloadingTS |
Any of 2 types
Время разгрузки. Example
|
|
fromUpdateTS |
Any of 2 types
ToCreateTS Не обязательноый параметр Example
|
|
fwdIds |
Type: string[] | null IDs Не обязательноый параметр Example
|
|
ids |
Type: string[] | null IDs Не обязательноый параметр Example
|
|
limit |
Type: integer | null Limit ограничение на количество рейсов на выходе. - Пусто == все |
|
loadPoint |
Any of 2 types
LoadPoint - Пусто == все Example
|
|
npFromAddress |
Type: string[] | null Example
|
|
npShipmentIds |
Type: string[] | null Example
|
|
npToAddress |
Type: string[] | null Example
|
|
npUnshipmentIds |
Type: string[] | null Example
|
|
orderCargoIds |
Type: string[] | null Example
|
|
orderCustomerComment |
Type: string[] | null Параметр "Комментарий" в разделе "Владелец груза" создания заказа Example
|
|
orderIds |
Type: string[] | null OrderIDs Не обязательноый параметр Example
|
|
packageNames |
Type: string[] | null Example
|
|
partialIds |
Type: string[] | null Example
|
|
responsibleLogisticianByExecutor |
Type: string[] | null ResponsibleLogisticianByExecutor id-сотрудников ответсвенных логистов. - Пусто == все Example
|
|
responsibleLogisticianByForwarder |
Type: string[] | null ResponsibleLogisticianByForwarder id-сотрудников ответсвенных логистов. - Пусто == все Example
|
|
responsibleLogisticianForOrderByExecutor |
Type: string[] | null ResponsibleLogisticianForOrderByExecutor id-сотрудников ответсвенных за заказ логистов. - Пусто == все Example
|
|
responsibleLogisticianForOrderByForwarder |
Type: string[] | null ResponsibleLogisticianForOrderByForwarder id-сотрудников ответсвенных за заказ логистов. - Пусто == все Example
|
|
shipmentNames |
Type: string[] | null Example
|
|
sort |
Any of 2 types
Example
|
|
states |
Type: string[] | null States Статусы рейса Не обязательноый параметр Example
|
|
toChooseWinnerTS |
Any of 2 types
Время определения победителя. Example
|
|
toCreateTS |
Any of 2 types
ToCreateTS Не обязательноый параметр Example
|
|
toLoadingTS |
Any of 2 types
Время погрузки. Example
|
|
toUnloadingTS |
Any of 2 types
Время разгрузки. Example
|
|
toUpdateTS |
Any of 2 types
ToCreateTS Не обязательноый параметр Example
|
|
trailerIds |
Type: string[] | null TrailerIDs - Пусто == все Example
|
|
truckIds |
Type: string[] | null CarsIDs - Пусто == все Example
|
|
unloadPoint |
Any of 2 types
UnloadPoint - Пусто == все Example
|
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"
],
"fromChooseWinnerTS": null,
"fromCreateTS": null,
"fromLoadingTS": null,
"fromUnloadingTS": null,
"fromUpdateTS": null,
"fwdIds": [
"example"
],
"ids": [
"example"
],
"limit": 0,
"loadPoint": null,
"npFromAddress": [
"example"
],
"npShipmentIds": [
"example"
],
"npToAddress": [
"example"
],
"npUnshipmentIds": [
"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"
],
"toChooseWinnerTS": null,
"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",
"name": "example",
"tin": "example"
},
"executerId": "example",
"extId": "example",
"externalExecutor": {},
"externalExecutorConditions": {},
"flightName": "example",
"flightWay": {},
"id": "example",
"isForwardingCompany": true,
"responsibleLogistician": {},
"status": "example",
"subStatus": "example",
"tasks": [
{}
],
"trailer": {},
"truck": null
}
]
}
}
|
Name |
Description |
|
data |
Type: FlightListForExecutorV1Response Example
|
FlightListForExecutorV1AlertInfo
|
Name |
Description |
|
alertType |
Type: string Example: |
|
description |
Type: string Example: |
Example
{
"alertType": "example",
"description": "example"
}
TimestampTZOutput
|
Name |
Description |
|
displayTZ |
Type: string Example: |
|
time |
Type: string<date-time> Example: |
Example
{
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
}
FlightListForExecutorV1DriverInfoForExecutorFlightList
|
Name |
Description |
|
id |
Type: string Example: |
|
isActual |
Type: boolean |
|
masked_phone |
Type: string Example: |
|
name |
Type: string Example: |
Example
{
"id": "example",
"isActual": true,
"masked_phone": "example",
"name": "example"
}
FlightListForExecutorV1OrgInfoForExecutor
|
Name |
Description |
|
id |
Type: string Example: |
|
name |
Type: string Example: |
|
tin |
Type: string Example: |
Example
{
"id": "example",
"name": "example",
"tin": "example"
}
FlightListForExecutorV1ExternalExecutor
|
Name |
Description |
|
country |
Type: string Example: |
|
name |
Type: string Example: |
|
orgType |
Type: string Example: |
|
tin |
Type: string Код типа доступа к коменнтарию Example: |
|
contactEmail |
Type: string | null Example: |
|
contactName |
Type: string | null Example: |
|
contactPhone |
Type: string | null Example: |
|
legalAddress |
Type: string | null Юридический адрес одной строкой 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
}
FlightListForExecutorV1DocumentsDelay
|
Name |
Description |
|
daysTypeAfterDocuments |
Type: string | null Дни (после предоставления документов) - рабочие/календарные Example: |
|
daysTypeBeforeDocuments |
Type: string | null Дни (до предоставления документов) - рабочие/календарные Example: |
|
delayAfterDocuments |
Type: integer | null Отсрочка, дней (после предоставления документов) |
|
delayBeforeDocuments |
Type: integer | null Отсрочка, дней (до предоставления документов) |
Example
{
"daysTypeAfterDocuments": "example",
"daysTypeBeforeDocuments": "example",
"delayAfterDocuments": 0,
"delayBeforeDocuments": 0
}
FlightListForExecutorV1ExternalExecutorConditions
|
Name |
Description |
|
additionalComment |
Type: string | null Комментарий Example: |
|
currency |
Type: string | null Валюта (селектор) Example: |
|
documentsDelay |
Any of 2 types
Отсрочка документов Example
|
|
isVatPayer |
Type: boolean | null Является ли плательщиком НДС |
|
price |
Type: number | null Стоимость без НДС |
|
priceWithVat |
Type: number | null Стоимость с НДС |
|
vat |
Type: number | null НДС |
Example
{
"additionalComment": "example",
"currency": "example",
"documentsDelay": {
"daysTypeAfterDocuments": "example",
"daysTypeBeforeDocuments": "example",
"delayAfterDocuments": 0,
"delayBeforeDocuments": 0
},
"isVatPayer": true,
"price": 0.5,
"priceWithVat": 0.5,
"vat": 0.5
}
FlightListForExecutorV1FlightWayActionRelation
|
Name |
Description |
|
flightId |
Type: string ID рейса Example: |
|
flightTaskId |
Type: string ID задачи перевозки Example: |
|
isTransferTaskDeleted |
Type: boolean Задача на перевозку (Груз) удалена из заказа |
|
isTransferTaskRevoked |
Type: boolean Задача на перевозку (Груз) отозвана из исполнения у исполнителя |
|
orderId |
Type: string ID заказа Example: |
|
shipmentId |
Type: string ID груза Example: |
|
shipmentName |
Type: string Название груза Example: |
|
transferTaskId |
Type: string ID задачи перевозки Example: |
Example
{
"flightId": "example",
"flightTaskId": "example",
"isTransferTaskDeleted": true,
"isTransferTaskRevoked": true,
"orderId": "example",
"shipmentId": "example",
"shipmentName": "example",
"transferTaskId": "example"
}
FlightListForExecutorV1FlightWayAction
|
Name |
Description |
|
actionId |
Type: string ID действия Example: |
|
actionType |
Type: string Что нужно сделать на маршруте (loading - погрузить груз, unloading - выгрузить груз, transit - не выгружать уже погруженный груз) Example: |
|
orderInVisit |
Type: integer порядок выполнения задач в узле |
|
relation |
Any of 2 types
Связь с задачей перевозки (груз, заказ, рейс) 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"
}
}
FlightListForExecutorV1FlightWayPoint
|
Name |
Description |
|
address |
Type: string Адрес точки Example: |
|
id |
Type: string ID точки Example: |
|
lat |
Type: number Широта точки |
|
locality |
Type: string Город точки Example: |
|
long |
Type: number Долгота точки |
|
province |
Type: string Провинция точки Example: |
|
addressComment |
Type: string | null Комментарий к адресу Example: |
|
name |
Type: string | null Название точки Example: |
|
tin |
Type: string | null ИНН точки Example: |
Example
{
"address": "example",
"addressComment": "example",
"id": "example",
"lat": 0.5,
"locality": "example",
"long": 0.5,
"name": "example",
"province": "example",
"tin": "example"
}
FlightListForExecutorV1FlightWayVisit
|
Name |
Description |
|
id |
Type: string ID посещения Example: |
|
orderInWay |
Type: integer Порядок посещения точек в маршруте |
|
startAt |
All of 1 type
Дата начала посещения Example
|
|
actions |
Type: FlightListForExecutorV1FlightWayAction[] | null Действия, которые нужно выполнить на маршруте Example
|
|
endAt |
Any of 2 types
Дата окончания посещения Example
|
|
wayPoint |
Any of 2 types
Точка на маршруте 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"
}
}
FlightListForExecutorV1FlightWay
|
Name |
Description |
|
createdAt |
All of 1 type
Дата создания маршрута Example
|
|
generationType |
Type: string Тип генерации (auto / manual) Example: |
|
id |
Type: string ID версии маршрута Example: |
|
updatedAt |
All of 1 type
Дата обновления маршрута Example
|
|
archivedAt |
Any of 2 types
Дата архивации маршрута Example
|
|
visits |
Type: FlightListForExecutorV1FlightWayVisit[] | null Посещения точек на маршруте следования 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: |
|
orgId |
Type: string | null Example: |
|
orgName |
Type: string | null Example: |
|
orgTin |
Type: string | null Example: |
|
publicEmail |
Type: string | null Example: |
|
publicPhone |
Type: string | null Example: |
|
type |
Type: string Example: |
|
value |
Type: string Example: |
Example
{
"name": "example",
"orgId": "example",
"orgName": "example",
"orgTin": "example",
"publicEmail": "example",
"publicPhone": "example",
"type": "example",
"value": "example"
}
FlightListForExecutorV1Document
|
Name |
Description |
|
expiration |
Type: TimestampTZOutput Example
|
|
issueDate |
Type: TimestampTZOutput Example
|
|
name |
Type: string Example: |
|
number |
Type: string Example: |
Example
{
"expiration": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"issueDate": null,
"name": "example",
"number": "example"
}
FlightListForExecutorV1OwnershipDetails
|
Name |
Description |
|
companyName |
Type: string Example: |
|
contractDate |
Type: TimestampTZOutput Example
|
|
contractName |
Type: string Example: |
|
contractNumber |
Type: string Example: |
|
ownerTIN |
Type: string Example: |
|
ownerType |
Type: string Example: |
Example
{
"companyName": "example",
"contractDate": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"contractName": "example",
"contractNumber": "example",
"ownerTIN": "example",
"ownerType": "example"
}
FlightListForExecutorV1CarInfoForExecutor
|
Name |
Description |
|
bodyType |
Type: string Example: |
|
brand |
Type: string Бренд (марка) автомобиля Example: |
|
createdAt |
All of 1 type
Дата создания автомобиля Example
|
|
height |
Type: number |
|
hydroBort |
Type: boolean |
|
id |
Type: string Example: |
|
length |
Type: number |
|
loadCapacity |
Type: number |
|
model |
Type: string Example: |
|
number |
Type: string Example: |
|
ownerCountry |
Type: string Страна владельца Example: |
|
ownerId |
Type: string Идентификатор владельца Example: |
|
ownerName |
Type: string Имя владельца автомобиля Example: |
|
ownershipType |
Type: string Тип владения ТС (собственность, совместная собственность супругов, лизинг, безвозмездное пользование, аренда) Example: |
|
palletCount |
Type: integer |
|
registrationCountry |
Type: string Страна регистрации автомобиля Example: |
|
type |
Type: string Example: |
|
vin |
Type: string VIN-номер автомобиля Example: |
|
volume |
Type: number |
|
width |
Type: number |
|
documents |
Type: FlightListForExecutorV1Document[] | null Example
|
|
imei |
Type: string[] | null Список IMEI Example
|
|
orgIdAllowed |
Type: string[] | null Список разрешённых организаций, для которых данный автомобиль может быть использован Example
|
|
ownershipContactId |
Type: string | null Id контакта владельца ТС Example: |
|
ownershipDetails |
Any of 2 types
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
}
FlightListForExecutorV1FlightTaskFlightInfo
|
Name |
Description |
|
canSetCar |
Type: boolean |
|
canSetDriver |
Type: boolean |
|
canSetStatus |
Type: boolean |
|
flightId |
Type: string Example: |
|
flightTaskId |
Type: string Example: |
|
flightTaskStatus |
Type: string Example: |
|
status |
Type: string Example: |
|
subStatus |
Type: string Example: |
|
arrivalLoadingAt |
Any of 2 types
Example
|
|
arrivalUnloadingAt |
Any of 2 types
Example
|
|
carHeadInfo |
Any of 2 types
Example
|
|
departureLoadingAt |
Any of 2 types
Example
|
|
departureUnloadingAt |
Any of 2 types
Example
|
|
driverInfo |
Any of 2 types
Example
|
|
endLoadingAt |
Any of 2 types
Example
|
|
endUnloadingAt |
Any of 2 types
Example
|
|
goToTheLoadingAt |
Any of 2 types
Example
|
|
loadingOrder |
Type: integer | null |
|
startLoadingAt |
Any of 2 types
Example
|
|
startUnloadingAt |
Any of 2 types
Example
|
|
trailerInfo |
Any of 2 types
Example
|
|
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
}
FlightListForExecutorV1NodalPointAdditionalContact
|
Name |
Description |
|
id |
Type: string Example: |
|
npcName |
Type: string Имя контактного лица. Example: |
|
npcPhone |
Type: string Телефон контактного лица. Example: |
Example
{
"id": "example",
"npcName": "example",
"npcPhone": "example"
}
FlightListForExecutorV1NpGeoAddress
|
Name |
Description |
|
address |
Type: string Example: |
|
lat |
Type: number |
|
locality |
Type: string Example: |
|
long |
Type: number |
|
province |
Type: string Example: |
Example
{
"address": "example",
"lat": 0.5,
"locality": "example",
"long": 0.5,
"province": "example"
}
FlightListForExecutorV1NodalPointShipmentPeriod
|
Name |
Description |
|
from |
Type: TimestampTZOutput Example
|
|
to |
Any of 2 types
Example
|
Example
{
"from": {
"displayTZ": "+03:00",
"time": "2020-01-01T00:00:00"
},
"to": null
}
FlightListForExecutorV1NodalPointShipment
|
Name |
Description |
|
content |
Type: string Содержимое разгрузки/погрузки. Example: |
|
country |
Type: string Страна разгрузки/погрузки. Example: |
|
id |
Type: string Example: |
|
name |
Type: string Название разгрузки/погрузки. Example: |
|
npGeoAddress |
All of 1 type
Геоадрес разгрузки/погрузки. Example
|
|
npLegalType |
Type: string Юридический тип разгрузки/погрузки. Example: |
|
npTin |
Type: string ИНН разгрузки/погрузки. Example: |
|
period |
All of 1 type
Период разгрузки/погрузки. если в периоде, не заполнено поле to, то считаем не периодом, а точной датой Example
|
|
position |
Type: integer очередь разгрузки/погрузки. |
|
addressComment |
Type: string | null Комментарий к адресу Example: |
|
legalAddress |
Type: string | null юридический адрес компании которая производит разгрузку/погрузку Example: |
|
legalPhone |
Type: string | null Example: |
|
npAdditionalContact |
Type: FlightListForExecutorV1NodalPointAdditionalContact[] | null Дополнительные контакты разгрузки/погрузки. Example
|
|
npShipmentId |
Type: string | null Идентификатор разгрузки/погрузки. Example: |
Example
{
"addressComment": "example",
"content": "example",
"country": "example",
"id": "example",
"legalAddress": "example",
"legalPhone": "example",
"name": "example",
"npAdditionalContact": [
{
"id": "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
}
FlightListForExecutorV1CargoCategory
|
Name |
Description |
|
category |
Type: string Тип груза. Example: |
|
categoryComment |
Type: string Коментарий к типу груза. Example: |
Example
{
"category": "example",
"categoryComment": "example"
}
FlightListForExecutorV1Customer
|
Name |
Description |
|
customerAddress |
Type: string адрес заказчика Example: |
|
customerCountry |
Type: string страна заказчика Example: |
|
customerName |
Type: string Имя контактного лица заказчика перевозки. Example: |
|
customerPhone |
Type: string Телефон контактного лица заказчика перевозки. Example: |
|
customerTin |
Type: string ИНН / БИН или другой уникальный налоговый номер Example: |
|
id |
Type: string Example: |
|
customerCargoPrice |
Type: number | null стоимость груза в блоке заказчика |
|
customerLegalForm |
Type: string | null юридическая форма организации (OOO,ИП др) Example: |
Example
{
"customerAddress": "example",
"customerCargoPrice": 0.5,
"customerCountry": "example",
"customerLegalForm": "example",
"customerName": "example",
"customerPhone": "example",
"customerTin": "example",
"id": "example"
}
FlightListForExecutorV1Dimensions
|
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
}
FlightListForExecutorV1Partner
|
Name |
Description |
|
id |
Type: string Example: |
|
tin |
Type: string Example: |
Example
{
"id": "example",
"tin": "example"
}
FlightListForExecutorV1Distribution
|
Name |
Description |
|
comment |
Type: string Комментарий, например, "какие-то условия" Example: |
|
currency |
Type: string Валюта, например, "rub" Example: |
|
day_doc_close |
Type: integer Количество дней до закрытия документа, например, 2 |
|
day_doc_delay |
Type: integer Количество дней задержки документа, например, 3 |
|
doc_format |
Type: string формат предоставления Example: |
|
public_matcher |
Type: boolean открытый аукцион или нет |
|
type |
Type: string Тип определения исполнителя, например, "Отправить в свои заказы" Example: |
|
type_doc_close |
Type: string Тип документа для закрытия, например, "bankdays" Example: |
|
type_doc_delay |
Type: string Тип документа для задержки, например, "bankdays" Example: |
|
amount |
Type: number | null Заявленная стоимость торгов (Сумма, например, 123) |
|
partners |
Type: FlightListForExecutorV1Partner[] | null Исполнители (ТОЛЬКО в которых можно участвовать) Example
|
Example
{
"amount": 0.5,
"comment": "example",
"currency": "example",
"day_doc_close": 0,
"day_doc_delay": 0,
"doc_format": "example",
"partners": [
{
"id": "example",
"tin": "example"
}
],
"public_matcher": true,
"type": "example",
"type_doc_close": "example",
"type_doc_delay": "example"
}
FlightListForExecutorV1PaymentDelayPeriod
|
Name |
Description |
|
paymentType |
Type: string Тип оплаты. Example: |
|
daysDelayPeriod |
Type: integer | null Количество дней отсрочки платяжа. |
|
postPayCalendarType |
Type: string | null Тип постоплаты. Example: |
Example
{
"daysDelayPeriod": 0,
"paymentType": "example",
"postPayCalendarType": "example"
}
FlightListForExecutorV1TemperatureRegime
|
Name |
Description |
|
from |
Type: integer Температура градусов в цельсиях, минимум. |
|
to |
Type: integer Температура градусов в цельсиях, максимум. |
Example
{
"from": 0,
"to": 0
}
FlightListForExecutorV1Price
|
Name |
Description |
|
currency |
Type: string Валюта. Example: |
|
price |
Type: number Цена с точностью до 2х знаков. |
Example
{
"currency": "example",
"price": 0.5
}
FlightListForExecutorV1OrderInfo
|
Name |
Description |
|
bodyTypeComment |
Type: string Комментарий к типу кузова. Example: |
|
cargoCategory |
All of 1 type
Категория груза. Example
|
|
currency |
Type: string Example: |
|
customer |
All of 1 type
Инфорация о перевозке. Example
|
|
forwarder |
All of 1 type
Сведения о заказчике Example
|
|
orderId |
Type: string Example: |
|
orderStatus |
Type: string Example: |
|
transferOrderType |
Type: string FTL LTL Example: |
|
bodyType |
Type: string[] | null Тип кузова. Example
|
|
cargoId |
Type: string | null Example: |
|
dimensions |
Any of 2 types
Вес и объём. Example
|
|
distribution |
Any of 2 types
Example
|
|
execResponsibleLogistician |
Any of 2 types
Example
|
|
fwdResponsibleLogistician |
Any of 2 types
Example
|
|
paymentDelayPeriod |
Any of 2 types
Отсрочка платежа. Example
|
|
responsibleCustomer |
Any of 2 types
Example
|
|
temperatureRegime |
Type: FlightListForExecutorV1TemperatureRegime[] | null Температурный режим. Example
|
|
transferOrderAdditionalConditions |
Type: string | null Дополнительные условия заказа. Example: |
|
transferOrderCost |
Any of 2 types
Стоимость заказа. Example
|
|
transferOrderName |
Type: string | null Отображаемое имя заказа на перевозку. Example: |
|
transshipmentTypes |
Type: string[] | null Тип загрузки и выгрузки. Example
|
|
typePaymentAndTax |
Type: string | null Тип оплаты платежа. Example: |
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",
"day_doc_close": 0,
"day_doc_delay": 0,
"doc_format": "example",
"partners": [
{
"id": "example",
"tin": "example"
}
],
"public_matcher": true,
"type": "example",
"type_doc_close": "example",
"type_doc_delay": "example"
},
"execResponsibleLogistician": {
"name": "example",
"orgId": "example",
"orgName": "example",
"orgTin": "example",
"publicEmail": "example",
"publicPhone": "example",
"type": "example",
"value": "example"
},
"forwarder": {
"id": "example",
"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"
}
FlightListForExecutorV1Package
|
Name |
Description |
|
count |
Type: integer Количество |
|
hazardClass |
Type: string класс опасности Example: |
|
isDeleted |
Type: boolean Помечен ли на удаление |
|
packageId |
Type: string Example: |
|
packageName |
Type: string Отображаемое имя единицы товара. Example: |
|
stackability |
Type: string стакающийся? Example: |
|
amount |
Type: number | null Объявленная стоимость |
|
capacity |
Type: number | null Объем |
|
currency |
Type: string | null Валюта Example: |
|
packageExternalId |
Type: string | null Идентификатор единицы товара со стороны заказчика. Example: |
|
shipmentBodyType |
Type: string | null Тип упаковки груза. 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
}
FlightListForExecutorV1Shipment
|
Name |
Description |
|
flightTaskId |
Type: string Example: |
|
isDeleted |
Type: boolean Помечен ли на удаление |
|
isRevoked |
Type: boolean Отозван ли из исполнения |
|
name |
Type: string Example: |
|
npShipment |
Type: FlightListForExecutorV1NodalPointShipment Example
|
|
npShipmentId |
Type: string Погрузка Example: |
|
npUnshipment |
All of 1 type
Разгрузка Example
|
|
packageType |
Type: string Example: |
|
shipmentId |
Type: string Example: |
|
taskStatus |
Type: string Example: |
|
transferOrderTaskID |
Type: string Example: |
|
comment |
Type: string | null Комментарий к грузу Example: |
|
flightInfo |
Any of 2 types
Example
|
|
orderInfo |
Any of 2 types
Example
|
|
packages |
Type: FlightListForExecutorV1Package[] | null Example
|
|
revokedAt |
Any of 2 types
Когда был отозван Example
|
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",
"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": {
"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",
"day_doc_close": 0,
"day_doc_delay": 0,
"doc_format": "example",
"partners": [
null
],
"public_matcher": true,
"type": "example",
"type_doc_close": "example",
"type_doc_delay": "example"
},
"execResponsibleLogistician": {
"name": "example",
"orgId": "example",
"orgName": "example",
"orgTin": "example",
"publicEmail": "example",
"publicPhone": "example",
"type": "example",
"value": "example"
},
"forwarder": {
"id": "example",
"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"
}
FlightListForExecutorV1Flight
|
Name |
Description |
|
canSetCar |
Type: boolean |
|
canSetDriver |
Type: boolean |
|
canSetStatus |
Type: boolean |
|
executer |
Type: FlightListForExecutorV1OrgInfoForExecutor Example
|
|
executerId |
Type: string Example: |
|
extId |
Type: string Example: |
|
flightName |
Type: string Example: |
|
id |
Type: string Example: |
|
isForwardingCompany |
Type: boolean |
|
status |
Type: string Example: |
|
subStatus |
Type: string Example: |
|
alerts |
Type: FlightListForExecutorV1AlertInfo[] | null Alerts Яркие уведомления Example
|
|
canceledAt |
Any of 2 types
Example
|
|
completedAt |
Any of 2 types
Example
|
|
driver |
Any of 2 types
Example
|
|
externalExecutor |
Any of 2 types
Example
|
|
externalExecutorConditions |
Any of 2 types
Условия внешнего исполнителя Example
|
|
flightWay |
Any of 2 types
Версия связанного маршрута заказа. Заполняется асинхронно, может ссылаться на заархивированную версию Example
|
|
responsibleLogistician |
Any of 2 types
Example
|
|
tasks |
Type: FlightListForExecutorV1Shipment[] | null Example
|
|
trailer |
Any of 2 types
Example
|
|
truck |
Any of 2 types
Example
|
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",
"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
},
"externalExecutorConditions": {
"additionalComment": "example",
"currency": "example",
"documentsDelay": {
"daysTypeAfterDocuments": "example",
"daysTypeBeforeDocuments": "example",
"delayAfterDocuments": 0,
"delayBeforeDocuments": 0
},
"isVatPayer": true,
"price": 0.5,
"priceWithVat": 0.5,
"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": {
"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
}
FlightListForExecutorV1Response
|
Name |
Description |
|
flights |
Type: FlightListForExecutorV1Flight[] | null Example
|
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",
"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
},
"externalExecutorConditions": {
"additionalComment": "example",
"currency": "example",
"documentsDelay": null,
"isVatPayer": true,
"price": 0.5,
"priceWithVat": 0.5,
"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
|
Error
|
Name |
Description |
|
info |
Type: object Example
|
|
message |
Type: string Example: |
|
message_code |
Type: string Example: |
Example
{
"info": {},
"message": "example",
"message_code": "example"
}
403 Forbidden
Forbidden
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example
|