Получить заказ для редактирования

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

Назначение

Получите данные заказа перед обновлением. Передайте идентификатор в параметре id и используйте поля из data как исходные значения для запроса обновления.

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

Request

GET

https://partner-test-yamagistrali.ru/api/orders/v0/transferOrder/getForEdit

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

Query parameters

Name

Description

Type: string

Example: ``

Responses

200 OK

Body

application/json

{
  "data": {
    "agreementRules": {
      "isDriverCanChangePackagesWithoutApproval": true,
      "isExecutorCanChangePackagesWithoutApproval": true,
      "isExecutorCanChangeShipmentsWithoutApproval": true,
      "isForwarderCanChangePackagesWithoutApproval": true,
      "isForwarderCanChangeShipmentsWithoutApproval": true,
      "isWarehouseCanChangePackagesWithoutApproval": true
    },
    "auction": {
      "allowMultimodal": true,
      "auctionType": "example",
      "autoExtension": true,
      "autoExtensionActive": 0,
      "autoExtensionDuration": 0,
      "autoExtensionTime": 0,
      "autoSelection": true,
      "bargainingIsPossible": true,
      "bidStep": 0.5,
      "buyNowPrice": 0.5,
      "decreaseOnly": true,
      "decreaseOnlyFromDeclaredPrice": true,
      "duration": 0,
      "endDate": {},
      "hideBidsFromCarrier": true,
      "startDate": null,
      "tariffMatrixParams": {},
      "useTariffMatrix": true,
      "vat": 0.5,
      "vatAmount": 0.5,
      "vatInPriceNotConsider": true
    },
    "bodyType": [
      "example"
    ],
    "bodyTypeComment": "example",
    "cargoCategory": {
      "category": "example",
      "categoryComment": "example"
    },
    "cargoComment": "example",
    "cargoId": "example",
    "currency": "example",
    "customer": {
      "customerAddress": "example",
      "customerCargoPrice": 0.5,
      "customerComment": "example",
      "customerCountry": "example",
      "customerForwarderId": "example",
      "customerForwarderTin": "example",
      "customerLegalForm": "example",
      "customerName": "example",
      "customerPhone": "example",
      "customerTin": "example",
      "id": "example"
    },
    "dimensions": {
      "breadth": 0.5,
      "height": 0.5,
      "length": 0.5,
      "palletCount": 0,
      "volume": 0.5,
      "weight": 0.5
    },
    "distribution": {
      "amount": 0.5,
      "comment": "example",
      "currency": "example",
      "dayDocClose": 0,
      "dayDocDelay": 0,
      "docFormat": "example",
      "groups": [
        {}
      ],
      "groupsId": [
        "example"
      ],
      "partners": [
        {}
      ],
      "publicMatcher": true,
      "type": "example",
      "typeDocClose": "example",
      "typeDocDelay": "example"
    },
    "files": [
      {
        "id": "example",
        "name": "example"
      }
    ],
    "forwarder": {
      "forwarderComment": "example",
      "forwarderId": "example",
      "forwarderTin": "example"
    },
    "freeTags": [
      "example"
    ],
    "id": "example",
    "isVolumeAuction": true,
    "paymentDelayPeriod": {
      "daysDelayPeriod": 0,
      "paymentType": "example",
      "postPayCalendarType": "example"
    },
    "shipments": [
      {
        "distributionPriority": 0,
        "isDeleted": true,
        "name": "example",
        "npShipment": null,
        "npUnshipment": null,
        "packageType": "example",
        "packages": [
          {}
        ],
        "shipmentId": "example"
      }
    ],
    "status": "example",
    "tagId": "example",
    "tagsInfo": [
      {
        "code": "example",
        "name": "example"
      }
    ],
    "temperatureRegime": [
      {
        "from": 0,
        "label": "example",
        "to": 0
      }
    ],
    "transferOrderAdditionalConditions": "example",
    "transferOrderAdditionalConfiguration": {},
    "transferOrderCost": {
      "currency": "example",
      "price": 0.5
    },
    "transferOrderName": "example",
    "transferOrderType": "example",
    "transshipmentTypes": [
      "example"
    ],
    "typePaymentAndTax": "example",
    "utm": {
      "utmCampaign": "example",
      "utmContent": "example",
      "utmMedium": "example",
      "utmSource": "example",
      "utmTerm": "example"
    },
    "volumeAuction": {
      "auctionType": "example",
      "duration": 0,
      "endDate": null,
      "flightsCount": 0.5,
      "startDate": null,
      "tarifficationType": "example",
      "tonsCount": 0.5,
      "transitDistance": 0.5,
      "vehicleCapacityFrom": 0.5,
      "vehicleCapacityTo": 0.5
    }
  }
}

Name

Description

data

Type: OrdersV0TransferOrderGetForEditResponse

Example

{
  "agreementRules": {
    "isDriverCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangeShipmentsWithoutApproval": true,
    "isForwarderCanChangePackagesWithoutApproval": true,
    "isForwarderCanChangeShipmentsWithoutApproval": true,
    "isWarehouseCanChangePackagesWithoutApproval": true
  },
  "auction": {
    "allowMultimodal": true,
    "auctionType": "example",
    "autoExtension": true,
    "autoExtensionActive": 0,
    "autoExtensionDuration": 0,
    "autoExtensionTime": 0,
    "autoSelection": true,
    "bargainingIsPossible": true,
    "bidStep": 0.5,
    "buyNowPrice": 0.5,
    "decreaseOnly": true,
    "decreaseOnlyFromDeclaredPrice": true,
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "hideBidsFromCarrier": true,
    "startDate": null,
    "tariffMatrixParams": {
      "isWhoFirst": true,
      "tariffMatrixIds": [
        null
      ]
    },
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5,
    "vatInPriceNotConsider": true
  },
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoComment": "example",
  "cargoId": "example",
  "currency": "example",
  "customer": {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerComment": "example",
    "customerCountry": "example",
    "customerForwarderId": "example",
    "customerForwarderTin": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example",
    "id": "example"
  },
  "dimensions": {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "palletCount": 0,
    "volume": 0.5,
    "weight": 0.5
  },
  "distribution": {
    "amount": 0.5,
    "comment": "example",
    "currency": "example",
    "dayDocClose": 0,
    "dayDocDelay": 0,
    "docFormat": "example",
    "groups": [
      {
        "id": "example",
        "name": "example"
      }
    ],
    "groupsId": [
      "example"
    ],
    "partners": [
      {
        "id": "example",
        "isBlackList": true,
        "name": "example",
        "tin": "example"
      }
    ],
    "publicMatcher": true,
    "type": "example",
    "typeDocClose": "example",
    "typeDocDelay": "example"
  },
  "files": [
    {
      "id": "example",
      "name": "example"
    }
  ],
  "forwarder": {
    "forwarderComment": "example",
    "forwarderId": "example",
    "forwarderTin": "example"
  },
  "freeTags": [
    "example"
  ],
  "id": "example",
  "isVolumeAuction": true,
  "paymentDelayPeriod": {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  },
  "shipments": [
    {
      "distributionPriority": 0,
      "isDeleted": true,
      "name": "example",
      "npShipment": {
        "content": "example",
        "country": "example",
        "legalAddress": "example",
        "legalPhone": "example",
        "name": "example",
        "nodalPointId": "example",
        "npAdditionalContact": [
          null
        ],
        "npGeoAddress": null,
        "npLegalType": "example",
        "npShipmentId": "example",
        "npTin": "example",
        "period": null,
        "phoneCountryCode": "example",
        "position": 0,
        "sequenceOrder": 0
      },
      "npUnshipment": null,
      "packageType": "example",
      "packages": [
        {
          "amount": 0.5,
          "capacity": 0.5,
          "count": 0,
          "currency": "example",
          "dimensionHeight": 0.5,
          "dimensionLength": 0.5,
          "dimensionWeight": 0.5,
          "hazardClass": "example",
          "isDeleted": true,
          "packageExternalId": "example",
          "packageId": "example",
          "packageName": "example",
          "requirementPackageId": "example",
          "ruEdo": null,
          "shipmentBodyType": "example",
          "stackability": "example",
          "weight": 0.5
        }
      ],
      "shipmentId": "example"
    }
  ],
  "status": "example",
  "tagId": "example",
  "tagsInfo": [
    {
      "code": "example",
      "name": "example"
    }
  ],
  "temperatureRegime": [
    {
      "from": 0,
      "label": "example",
      "to": 0
    }
  ],
  "transferOrderAdditionalConditions": "example",
  "transferOrderAdditionalConfiguration": {},
  "transferOrderCost": {
    "currency": "example",
    "price": 0.5
  },
  "transferOrderName": "example",
  "transferOrderType": "example",
  "transshipmentTypes": [
    "example"
  ],
  "typePaymentAndTax": "example",
  "utm": {
    "utmCampaign": "example",
    "utmContent": "example",
    "utmMedium": "example",
    "utmSource": "example",
    "utmTerm": "example"
  },
  "volumeAuction": {
    "auctionType": "example",
    "duration": 0,
    "endDate": null,
    "flightsCount": 0.5,
    "startDate": null,
    "tarifficationType": "example",
    "tonsCount": 0.5,
    "transitDistance": 0.5,
    "vehicleCapacityFrom": 0.5,
    "vehicleCapacityTo": 0.5
  }
}

OrdersV0TransferOrderGetForEditAgreementRules

Name	Description
isDriverCanChangePackagesWithoutApproval	Type: boolean Может ли водитель менять места в заказе без согласования
isExecutorCanChangePackagesWithoutApproval	Type: boolean Может ли исполнитель менять места в заказе без согласования
isExecutorCanChangeShipmentsWithoutApproval	Type: boolean Может ли исполнитель менять грузы в заказе без согласования
isForwarderCanChangePackagesWithoutApproval	Type: boolean Может ли заказчик менять места в заказе без согласования
isForwarderCanChangeShipmentsWithoutApproval	Type: boolean Может ли заказчик менять грузы в заказе без согласования
isWarehouseCanChangePackagesWithoutApproval	Type: boolean Может ли склад менять места в заказе без согласования

Example

{
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}

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"
}

OrdersV0TransferOrderGetForEditTariffMatrixInfo

Name

Description

tariffMatrixId

Type: string

Идентификатор Тарифной матрицы

Example: example

Example

{
  "tariffMatrixId": "example"
}

OrdersV0TransferOrderGetForEditTariffMatrixParams

Name

Description

isWhoFirst

Type: boolean

Торговля по принципу кто первый

tariffMatrixIds

Type: OrdersV0TransferOrderGetForEditTariffMatrixInfo[] | null

Параметры тарифных матриц

Example

[
  {
    "tariffMatrixId": "example"
  }
]

Example

{
  "isWhoFirst": true,
  "tariffMatrixIds": [
    {
      "tariffMatrixId": "example"
    }
  ]
}

OrdersV0TransferOrderGetForEditAuction

Name	Description
allowMultimodal	Type: boolean Разрешить мультимодальный торг
auctionType	Type: string тип торгов Example: `example`
autoExtension	Type: boolean Автопродление
autoExtensionActive	Type: integer Время Активации автопродления в сеуундах
autoExtensionDuration	Type: integer Максимальное длительность продления в секундах
autoExtensionTime	Type: integer Время продления в секундах
autoSelection	Type: boolean Автовыбор
bargainingIsPossible	Type: boolean торг возможен
decreaseOnly	Type: boolean Только на понижение
decreaseOnlyFromDeclaredPrice	Type: boolean Только на понижение от заданной цены
duration	Type: integer Длительность торгов в секундах
hideBidsFromCarrier	Type: boolean Скрывать ставки от исполнителя
useTariffMatrix	Type: boolean Торги Тарифная матрица
vatInPriceNotConsider	Type: boolean без учёта НДС
bidStep	Type: number \| null Шаг торгов
buyNowPrice	Type: number \| null «Buy now» (input - число)
endDate	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" }`
startDate	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" }`
tariffMatrixParams	Any of 2 types Type: OrdersV0TransferOrderGetForEditTariffMatrixParams Example `{ "isWhoFirst": true, "tariffMatrixIds": [ { "tariffMatrixId": "example" } ] }` Type: object \| null Const: `null` Example `{}` Параметры Тарифной матрицы Example `{ "isWhoFirst": true, "tariffMatrixIds": [ { "tariffMatrixId": "example" } ] }`
vat	Type: number \| null НДС Distribution.amount (опциональное)
vatAmount	Type: number \| null НДС Distribution.amount (опциональное)

Example

{
  "allowMultimodal": true,
  "auctionType": "example",
  "autoExtension": true,
  "autoExtensionActive": 0,
  "autoExtensionDuration": 0,
  "autoExtensionTime": 0,
  "autoSelection": true,
  "bargainingIsPossible": true,
  "bidStep": 0.5,
  "buyNowPrice": 0.5,
  "decreaseOnly": true,
  "decreaseOnlyFromDeclaredPrice": true,
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "hideBidsFromCarrier": true,
  "startDate": null,
  "tariffMatrixParams": {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {
        "tariffMatrixId": "example"
      }
    ]
  },
  "useTariffMatrix": true,
  "vat": 0.5,
  "vatAmount": 0.5,
  "vatInPriceNotConsider": true
}

OrdersV0TransferOrderGetForEditCargoCategory

Name

Description

category

Type: string

Тип груза.

Example: example

categoryComment

Type: string

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

Example: example

Example

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

OrdersV0TransferOrderGetForEditCustomer

Name	Description
customerAddress	Type: string адрес заказчика Example: `example`
customerComment	Type: string Комментарий заказчика Example: `example`
customerCountry	Type: string страна заказчика Example: `example`
customerForwarderId	Type: string Идентификатор организации владельца груза в роли заказчика Example: `example`
customerLegalForm	Type: string юридическая форма организации (OOO,ИП др) 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 стоимость груза в блоке заказчика
customerForwarderTin	Type: string \| null Example: `example`

Example

{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerForwarderTin": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example",
  "id": "example"
}

OrdersV0TransferOrderGetForEditDimensions

Name	Description
breadth	Type: number \| null Ширина с точностью до 2х знактов.
height	Type: number \| null Высота с точностью до 2х знактов.
length	Type: number \| null Длина с точностью до 2х знактов.
palletCount	Type: integer \| null Количество палет.
volume	Type: number \| null Объём с точностью до 3х знактов.
weight	Type: number \| null Вес в КГ.

Example

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

OrdersV0TransferOrderGetForEditGroup

Name

Description

Type: string

Example: example

name

Type: string

Example: example

Example

{
  "id": "example",
  "name": "example"
}

OrdersV0TransferOrderGetForEditPartner

Name	Description
id	Type: string Example: `example`
isBlackList	Type: boolean
name	Type: string Example: `example`
tin	Type: string Example: `example`

Example

{
  "id": "example",
  "isBlackList": true,
  "name": "example",
  "tin": "example"
}

OrdersV0TransferOrderGetForEditDistribution

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)
groups	Type: OrdersV0TransferOrderGetForEditGroup[] \| null Группы, связанные с определением исполнителя Example `[ { "id": "example", "name": "example" } ]`
groupsId	Type: string[] \| null Группы, связанные с определением исполнителя (пока неизвестно, что конкретно будет в этом массиве) Example `[ "example" ]`
partners	Type: OrdersV0TransferOrderGetForEditPartner[] \| null Исполнители Example `[ { "id": "example", "isBlackList": true, "name": "example", "tin": "example" } ]`

Example

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

OrdersV0TransferOrderGetForEditForwarder

Name	Description
forwarderId	Type: string Идентификатор заказчика в сервисе Яндекс Магистрали Example: `example`
forwarderComment	Type: string \| null Комментарий заказчика Example: `example`
forwarderTin	Type: string \| null ИНН заказчика Example: `example`

Example

{
  "forwarderComment": "example",
  "forwarderId": "example",
  "forwarderTin": "example"
}

OrdersV0TransferOrderGetForEditPaymentDelayPeriod

Name	Description
paymentType	Type: string Тип оплаты. Example: `example`
daysDelayPeriod	Type: integer \| null Количество дней отсрочки платяжа.
postPayCalendarType	Type: string \| null Тип постоплаты. Example: `example`

Example

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

OrdersV0TransferOrderGetForEditNodalPointAdditionalContact

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"
}

OrdersV0TransferOrderGetForEditNpGeoAddress

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"
}

OrdersV0TransferOrderGetForEditNodalPointShipmentPeriod

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
}

OrdersV0TransferOrderGetForEditNodalPointShipment

Name	Description
content	Type: string Содержимое разгрузки/погрузки. Example: `example`
country	Type: string Страна разгрузки/погрузки. Example: `example`
name	Type: string Название разгрузки/погрузки. Example: `example`
nodalPointId	Type: string Example: `example`
npGeoAddress	All of 1 type Type: OrdersV0TransferOrderGetForEditNpGeoAddress Example `{ "address": "example", "lat": 0.5, "locality": "example", "long": 0.5, "province": "example" }` Геоадрес разгрузки/погрузки. 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 Type: OrdersV0TransferOrderGetForEditNodalPointShipmentPeriod Example `{ "from": { "displayTZ": "+03:00", "time": "2020-01-01T00:00:00" }, "to": null }` Период разгрузки/погрузки. если в периоде, не заполнено поле to, то считаем не периодом, а точной датой Example `{ "from": { "displayTZ": "+03:00", "time": "2020-01-01T00:00:00" }, "to": null }`
phoneCountryCode	Type: string Идентификатор страны телефона контактного лица. Example: `example`
position	Type: integer очередь разгрузки/погрузки.
legalAddress	Type: string \| null юридический адрес компании которая производит разгрузку/погрузку Example: `example`
legalPhone	Type: string \| null Example: `example`
npAdditionalContact	Type: OrdersV0TransferOrderGetForEditNodalPointAdditionalContact[] \| null Дополнительные контакты разгрузки/погрузки. Example `[ { "id": "example", "npcExternalId": "example", "npcName": "example", "npcPhone": "example" } ]`
npShipmentId	Type: string \| null Идентификатор разгрузки/погрузки. Example: `example`
sequenceOrder	Type: integer \| null

Example

{
  "content": "example",
  "country": "example",
  "legalAddress": "example",
  "legalPhone": "example",
  "name": "example",
  "nodalPointId": "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
  },
  "phoneCountryCode": "example",
  "position": 0,
  "sequenceOrder": 0
}

OrdersV0TransferOrderGetForEditDangerousCargo

Name	Description
hazardClass	Type: string Example: `example`
classificationCode	Type: string \| null Example: `example`
competentAuthoritySign	Type: string \| null Example: `example`
controlTemperature	Type: string \| null Example: `example`
description	Type: string \| null Example: `example`
emergencyTemperature	Type: string \| null Example: `example`
explosiveNetMass	Type: string \| null Example: `example`
explosiveNetMassTotal	Type: string \| null Example: `example`
hazardLabel	Type: string \| null Example: `example`
holdTimeExpiryDate	Type: string \| null Example: `2006-01-02T00:00:00Z`
maxActivity	Type: string \| null Example: `example`
mixtureCompositionPercent	Type: string \| null Example: `example`
packageCategory	Type: string \| null Example: `example`
packingGroup	Type: string \| null Example: `example`
physicalChemicalDescription	Type: string \| null Example: `example`
properShippingName	Type: string \| null Example: `example`
radionuclideName	Type: string \| null Example: `example`
regulatoryAct	Type: string \| null Example: `example`
safetyIndex	Type: string \| null Example: `example`
technicalName	Type: string \| null Example: `example`
totalActivity	Type: string \| null Example: `example`
transportIndex	Type: string \| null Example: `example`
tunnelRestrictionCode	Type: string \| null Example: `example`
unHazardId	Type: string \| null Example: `example`

Example

{
  "classificationCode": "example",
  "competentAuthoritySign": "example",
  "controlTemperature": "example",
  "description": "example",
  "emergencyTemperature": "example",
  "explosiveNetMass": "example",
  "explosiveNetMassTotal": "example",
  "hazardClass": "example",
  "hazardLabel": "example",
  "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
  "maxActivity": "example",
  "mixtureCompositionPercent": "example",
  "packageCategory": "example",
  "packingGroup": "example",
  "physicalChemicalDescription": "example",
  "properShippingName": "example",
  "radionuclideName": "example",
  "regulatoryAct": "example",
  "safetyIndex": "example",
  "technicalName": "example",
  "totalActivity": "example",
  "transportIndex": "example",
  "tunnelRestrictionCode": "example",
  "unHazardId": "example"
}

OrdersV0TransferOrderGetForEditPackagesRuEdo

Name	Description
cargoState	Type: string \| null состояние груза Example: `example`
codeToVNom	Type: string \| null код товарной номенклатуры Example: `example`
dangerousCargo	Any of 2 types Type: OrdersV0TransferOrderGetForEditDangerousCargo Example { "classificationCode": "example", "competentAuthoritySign": "example", "controlTemperature": "example", "description": "example", "emergencyTemperature": "example", "explosiveNetMass": "example", "explosiveNetMassTotal": "example", "hazardClass": "example", "hazardLabel": "example", "holdTimeExpiryDate": "2006-01-02T00:00:00Z", "maxActivity": "example", "mixtureCompositionPercent": "example", "packageCategory": "example", "packingGroup": "example", "physicalChemicalDescription": "example", "properShippingName": "example", "radionuclideName": "example", "regulatoryAct": "example", "safetyIndex": "example", "technicalName": "example", "totalActivity": "example", "transportIndex": "example", "tunnelRestrictionCode": "example", "unHazardId": "example" } Type: object \| null Const: `null` Example `{}` сведения об опасном грузе Example { "classificationCode": "example", "competentAuthoritySign": "example", "controlTemperature": "example", "description": "example", "emergencyTemperature": "example", "explosiveNetMass": "example", "explosiveNetMassTotal": "example", "hazardClass": "example", "hazardLabel": "example", "holdTimeExpiryDate": "2006-01-02T00:00:00Z", "maxActivity": "example", "mixtureCompositionPercent": "example", "packageCategory": "example", "packingGroup": "example", "physicalChemicalDescription": "example", "properShippingName": "example", "radionuclideName": "example", "regulatoryAct": "example", "safetyIndex": "example", "technicalName": "example", "totalActivity": "example", "transportIndex": "example", "tunnelRestrictionCode": "example", "unHazardId": "example" }
mark	Type: string[] \| null маркировка Example `[ "example" ]`
pkgType	Type: string \| null тип упаковки Example: `example`

Example

{
  "cargoState": "example",
  "codeToVNom": "example",
  "dangerousCargo": {
    "classificationCode": "example",
    "competentAuthoritySign": "example",
    "controlTemperature": "example",
    "description": "example",
    "emergencyTemperature": "example",
    "explosiveNetMass": "example",
    "explosiveNetMassTotal": "example",
    "hazardClass": "example",
    "hazardLabel": "example",
    "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
    "maxActivity": "example",
    "mixtureCompositionPercent": "example",
    "packageCategory": "example",
    "packingGroup": "example",
    "physicalChemicalDescription": "example",
    "properShippingName": "example",
    "radionuclideName": "example",
    "regulatoryAct": "example",
    "safetyIndex": "example",
    "technicalName": "example",
    "totalActivity": "example",
    "transportIndex": "example",
    "tunnelRestrictionCode": "example",
    "unHazardId": "example"
  },
  "mark": [
    "example"
  ],
  "pkgType": "example"
}

OrdersV0TransferOrderGetForEditPackagesCreate

Name	Description
count	Type: integer Количество
hazardClass	Type: string класс опасности Example: `example`
isDeleted	Type: boolean
packageId	Type: string Example: `example`
stackability	Type: string стакающийся? Example: `example`
amount	Type: number \| null Объявленная стоимость
capacity	Type: number \| null Объем
currency	Type: string \| null Валюта Example: `example`
dimensionHeight	Type: number \| null
dimensionLength	Type: number \| null
dimensionWeight	Type: number \| null
packageExternalId	Type: string \| null Идентификатор единицы товара со стороны заказчика. Example: `example`
packageName	Type: string \| null Отображаемое имя единицы товара. Example: `example`
requirementPackageId	Type: string \| null Example: `example`
ruEdo	Any of 2 types Type: OrdersV0TransferOrderGetForEditPackagesRuEdo Example { "cargoState": "example", "codeToVNom": "example", "dangerousCargo": { "classificationCode": "example", "competentAuthoritySign": "example", "controlTemperature": "example", "description": "example", "emergencyTemperature": "example", "explosiveNetMass": "example", "explosiveNetMassTotal": "example", "hazardClass": "example", "hazardLabel": "example", "holdTimeExpiryDate": "2006-01-02T00:00:00Z", "maxActivity": "example", "mixtureCompositionPercent": "example", "packageCategory": "example", "packingGroup": "example", "physicalChemicalDescription": "example", "properShippingName": "example", "radionuclideName": "example", "regulatoryAct": "example", "safetyIndex": "example", "technicalName": "example", "totalActivity": "example", "transportIndex": "example", "tunnelRestrictionCode": "example", "unHazardId": "example" }, "mark": [ "example" ], "pkgType": "example" } Type: object \| null Const: `null` Example `{}` Данные для Российского ЭДО Example { "cargoState": "example", "codeToVNom": "example", "dangerousCargo": { "classificationCode": "example", "competentAuthoritySign": "example", "controlTemperature": "example", "description": "example", "emergencyTemperature": "example", "explosiveNetMass": "example", "explosiveNetMassTotal": "example", "hazardClass": "example", "hazardLabel": "example", "holdTimeExpiryDate": "2006-01-02T00:00:00Z", "maxActivity": "example", "mixtureCompositionPercent": "example", "packageCategory": "example", "packingGroup": "example", "physicalChemicalDescription": "example", "properShippingName": "example", "radionuclideName": "example", "regulatoryAct": "example", "safetyIndex": "example", "technicalName": "example", "totalActivity": "example", "transportIndex": "example", "tunnelRestrictionCode": "example", "unHazardId": "example" }, "mark": [ "example" ], "pkgType": "example" }
shipmentBodyType	Type: string \| null Тип упаковки груза. Example: `example`
weight	Type: number \| null Вес

Example

{
  "amount": 0.5,
  "capacity": 0.5,
  "count": 0,
  "currency": "example",
  "dimensionHeight": 0.5,
  "dimensionLength": 0.5,
  "dimensionWeight": 0.5,
  "hazardClass": "example",
  "isDeleted": true,
  "packageExternalId": "example",
  "packageId": "example",
  "packageName": "example",
  "requirementPackageId": "example",
  "ruEdo": {
    "cargoState": "example",
    "codeToVNom": "example",
    "dangerousCargo": {
      "classificationCode": "example",
      "competentAuthoritySign": "example",
      "controlTemperature": "example",
      "description": "example",
      "emergencyTemperature": "example",
      "explosiveNetMass": "example",
      "explosiveNetMassTotal": "example",
      "hazardClass": "example",
      "hazardLabel": "example",
      "holdTimeExpiryDate": "2006-01-02T00:00:00Z",
      "maxActivity": "example",
      "mixtureCompositionPercent": "example",
      "packageCategory": "example",
      "packingGroup": "example",
      "physicalChemicalDescription": "example",
      "properShippingName": "example",
      "radionuclideName": "example",
      "regulatoryAct": "example",
      "safetyIndex": "example",
      "technicalName": "example",
      "totalActivity": "example",
      "transportIndex": "example",
      "tunnelRestrictionCode": "example",
      "unHazardId": "example"
    },
    "mark": [
      "example"
    ],
    "pkgType": "example"
  },
  "shipmentBodyType": "example",
  "stackability": "example",
  "weight": 0.5
}

OrdersV0TransferOrderGetForEditShipmentCreate

Name	Description
isDeleted	Type: boolean
name	Type: string Example: `example`
npShipment	All of 1 type Type: OrdersV0TransferOrderGetForEditNodalPointShipment Example { "content": "example", "country": "example", "legalAddress": "example", "legalPhone": "example", "name": "example", "nodalPointId": "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 }, "phoneCountryCode": "example", "position": 0, "sequenceOrder": 0 } Погрузка Example { "content": "example", "country": "example", "legalAddress": "example", "legalPhone": "example", "name": "example", "nodalPointId": "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 }, "phoneCountryCode": "example", "position": 0, "sequenceOrder": 0 }
npUnshipment	All of 1 type Type: OrdersV0TransferOrderGetForEditNodalPointShipment Example { "content": "example", "country": "example", "legalAddress": "example", "legalPhone": "example", "name": "example", "nodalPointId": "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 }, "phoneCountryCode": "example", "position": 0, "sequenceOrder": 0 } Разгрузка Example { "content": "example", "country": "example", "legalAddress": "example", "legalPhone": "example", "name": "example", "nodalPointId": "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 }, "phoneCountryCode": "example", "position": 0, "sequenceOrder": 0 }
packageType	Type: string Example: `example`
shipmentId	Type: string Example: `example`
distributionPriority	Type: integer \| null
packages	Type: OrdersV0TransferOrderGetForEditPackagesCreate[] \| null Example [ { "amount": 0.5, "capacity": 0.5, "count": 0, "currency": "example", "dimensionHeight": 0.5, "dimensionLength": 0.5, "dimensionWeight": 0.5, "hazardClass": "example", "isDeleted": true, "packageExternalId": "example", "packageId": "example", "packageName": "example", "requirementPackageId": "example", "ruEdo": { "cargoState": "example", "codeToVNom": "example", "dangerousCargo": {}, "mark": [ "example" ], "pkgType": "example" }, "shipmentBodyType": "example", "stackability": "example", "weight": 0.5 } ]

Example

{
  "distributionPriority": 0,
  "isDeleted": true,
  "name": "example",
  "npShipment": {
    "content": "example",
    "country": "example",
    "legalAddress": "example",
    "legalPhone": "example",
    "name": "example",
    "nodalPointId": "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": {},
      "to": null
    },
    "phoneCountryCode": "example",
    "position": 0,
    "sequenceOrder": 0
  },
  "npUnshipment": null,
  "packageType": "example",
  "packages": [
    {
      "amount": 0.5,
      "capacity": 0.5,
      "count": 0,
      "currency": "example",
      "dimensionHeight": 0.5,
      "dimensionLength": 0.5,
      "dimensionWeight": 0.5,
      "hazardClass": "example",
      "isDeleted": true,
      "packageExternalId": "example",
      "packageId": "example",
      "packageName": "example",
      "requirementPackageId": "example",
      "ruEdo": {
        "cargoState": "example",
        "codeToVNom": "example",
        "dangerousCargo": null,
        "mark": [
          null
        ],
        "pkgType": "example"
      },
      "shipmentBodyType": "example",
      "stackability": "example",
      "weight": 0.5
    }
  ],
  "shipmentId": "example"
}

OrdersV0TransferOrderGetForEditTagInfo

Name

Description

code

Type: string

Example: example

name

Type: string

Example: example

Example

{
  "code": "example",
  "name": "example"
}

OrdersV0TransferOrderGetForEditTemperatureRegime

Name	Description
from	Type: integer Температура градусов в цельсиях, минимум.
to	Type: integer Температура градусов в цельсиях, максимум.
label	Type: string \| null Метка температурного режима. Example: `example`

Example

{
  "from": 0,
  "label": "example",
  "to": 0
}

JSONObject

Type: object

Example

{}

OrdersV0TransferOrderGetForEditPrice

Name

Description

currency

Type: string

Валюта.

Example: example

price

Type: number

Цена с точностью до 2х знаков.

Example

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

OrdersV0TransferOrderGetForEditUTM

Name	Description
utmSource	Type: string Example: `example`
utmCampaign	Type: string \| null Example: `example`
utmContent	Type: string \| null Example: `example`
utmMedium	Type: string \| null Example: `example`
utmTerm	Type: string \| null Example: `example`

Example

{
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}

OrdersV0TransferOrderGetForEditVolumeAuction

Name	Description
auctionType	Type: string Example: `example`
duration	Type: integer
tarifficationType	Type: string Example: `example`
transitDistance	Type: number
endDate	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" }`
flightsCount	Type: number \| null
startDate	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" }`
tonsCount	Type: number \| null
vehicleCapacityFrom	Type: number \| null
vehicleCapacityTo	Type: number \| null

Example

{
  "auctionType": "example",
  "duration": 0,
  "endDate": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "flightsCount": 0.5,
  "startDate": null,
  "tarifficationType": "example",
  "tonsCount": 0.5,
  "transitDistance": 0.5,
  "vehicleCapacityFrom": 0.5,
  "vehicleCapacityTo": 0.5
}

OrdersV0TransferOrderGetForEditResponse

Name	Description
bodyTypeComment	Type: string Комментарий к типу кузова. Example: `example`
cargoCategory	All of 1 type Type: OrdersV0TransferOrderGetForEditCargoCategory Example `{ "category": "example", "categoryComment": "example" }` Категория груза. Example `{ "category": "example", "categoryComment": "example" }`
currency	Type: string Валюта, например, "rub" Example: `example`
customer	All of 1 type Type: OrdersV0TransferOrderGetForEditCustomer Example `{ "customerAddress": "example", "customerCargoPrice": 0.5, "customerComment": "example", "customerCountry": "example", "customerForwarderId": "example", "customerForwarderTin": "example", "customerLegalForm": "example", "customerName": "example", "customerPhone": "example", "customerTin": "example", "id": "example" }` Инфорация о перевозке. Example `{ "customerAddress": "example", "customerCargoPrice": 0.5, "customerComment": "example", "customerCountry": "example", "customerForwarderId": "example", "customerForwarderTin": "example", "customerLegalForm": "example", "customerName": "example", "customerPhone": "example", "customerTin": "example", "id": "example" }`
forwarder	All of 1 type Type: OrdersV0TransferOrderGetForEditForwarder Example `{ "forwarderComment": "example", "forwarderId": "example", "forwarderTin": "example" }` Сведения о заказчике Example `{ "forwarderComment": "example", "forwarderId": "example", "forwarderTin": "example" }`
id	Type: string Example: `example`
isVolumeAuction	Type: boolean
status	Type: string Example: `example`
transferOrderAdditionalConfiguration	Type: JSONObject Example `{}`
transferOrderType	Type: string FTL LTL Example: `example`
agreementRules	Any of 2 types Type: OrdersV0TransferOrderGetForEditAgreementRules Example `{ "isDriverCanChangePackagesWithoutApproval": true, "isExecutorCanChangePackagesWithoutApproval": true, "isExecutorCanChangeShipmentsWithoutApproval": true, "isForwarderCanChangePackagesWithoutApproval": true, "isForwarderCanChangeShipmentsWithoutApproval": true, "isWarehouseCanChangePackagesWithoutApproval": true }` Type: object \| null Const: `null` Example `{}` Правила согласования Example `{ "isDriverCanChangePackagesWithoutApproval": true, "isExecutorCanChangePackagesWithoutApproval": true, "isExecutorCanChangeShipmentsWithoutApproval": true, "isForwarderCanChangePackagesWithoutApproval": true, "isForwarderCanChangeShipmentsWithoutApproval": true, "isWarehouseCanChangePackagesWithoutApproval": true }`
auction	Any of 2 types Type: OrdersV0TransferOrderGetForEditAuction Example { "allowMultimodal": true, "auctionType": "example", "autoExtension": true, "autoExtensionActive": 0, "autoExtensionDuration": 0, "autoExtensionTime": 0, "autoSelection": true, "bargainingIsPossible": true, "bidStep": 0.5, "buyNowPrice": 0.5, "decreaseOnly": true, "decreaseOnlyFromDeclaredPrice": true, "duration": 0, "endDate": { "displayTZ": "+03:00", "time": "2020-01-01T00:00:00" }, "hideBidsFromCarrier": true, "startDate": null, "tariffMatrixParams": { "isWhoFirst": true, "tariffMatrixIds": [ { "tariffMatrixId": "example" } ] }, "useTariffMatrix": true, "vat": 0.5, "vatAmount": 0.5, "vatInPriceNotConsider": true } Type: object \| null Const: `null` Example `{}` Example { "allowMultimodal": true, "auctionType": "example", "autoExtension": true, "autoExtensionActive": 0, "autoExtensionDuration": 0, "autoExtensionTime": 0, "autoSelection": true, "bargainingIsPossible": true, "bidStep": 0.5, "buyNowPrice": 0.5, "decreaseOnly": true, "decreaseOnlyFromDeclaredPrice": true, "duration": 0, "endDate": { "displayTZ": "+03:00", "time": "2020-01-01T00:00:00" }, "hideBidsFromCarrier": true, "startDate": null, "tariffMatrixParams": { "isWhoFirst": true, "tariffMatrixIds": [ {} ] }, "useTariffMatrix": true, "vat": 0.5, "vatAmount": 0.5, "vatInPriceNotConsider": true }
bodyType	Type: string[] \| null Тип кузова. Example `[ "example" ]`
cargoComment	Type: string \| null Example: `example`
cargoId	Type: string \| null Example: `example`
dimensions	Any of 2 types Type: OrdersV0TransferOrderGetForEditDimensions Example `{ "breadth": 0.5, "height": 0.5, "length": 0.5, "palletCount": 0, "volume": 0.5, "weight": 0.5 }` Type: object \| null Const: `null` Example `{}` Вес и объём. Example `{ "breadth": 0.5, "height": 0.5, "length": 0.5, "palletCount": 0, "volume": 0.5, "weight": 0.5 }`
distribution	Any of 2 types Type: OrdersV0TransferOrderGetForEditDistribution Example `{ "amount": 0.5, "comment": "example", "currency": "example", "dayDocClose": 0, "dayDocDelay": 0, "docFormat": "example", "groups": [ { "id": "example", "name": "example" } ], "groupsId": [ "example" ], "partners": [ { "id": "example", "isBlackList": true, "name": "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", "groups": [ { "id": "example", "name": "example" } ], "groupsId": [ "example" ], "partners": [ { "id": "example", "isBlackList": true, "name": "example", "tin": "example" } ], "publicMatcher": true, "type": "example", "typeDocClose": "example", "typeDocDelay": "example" }`
files	Type: OrdersV0TransferOrderGetForEditFiles[] \| null Example `[ { "id": "example", "name": "example" } ]`
freeTags	Type: string[] \| null Теги заказчика Example `[ "example" ]`
paymentDelayPeriod	Any of 2 types Type: OrdersV0TransferOrderGetForEditPaymentDelayPeriod Example `{ "daysDelayPeriod": 0, "paymentType": "example", "postPayCalendarType": "example" }` Type: object \| null Const: `null` Example `{}` Отсрочка платежа. Example `{ "daysDelayPeriod": 0, "paymentType": "example", "postPayCalendarType": "example" }`
shipments	Type: OrdersV0TransferOrderGetForEditShipmentCreate[] \| null Example [ { "distributionPriority": 0, "isDeleted": true, "name": "example", "npShipment": { "content": "example", "country": "example", "legalAddress": "example", "legalPhone": "example", "name": "example", "nodalPointId": "example", "npAdditionalContact": [ {} ], "npGeoAddress": null, "npLegalType": "example", "npShipmentId": "example", "npTin": "example", "period": null, "phoneCountryCode": "example", "position": 0, "sequenceOrder": 0 }, "npUnshipment": null, "packageType": "example", "packages": [ { "amount": 0.5, "capacity": 0.5, "count": 0, "currency": "example", "dimensionHeight": 0.5, "dimensionLength": 0.5, "dimensionWeight": 0.5, "hazardClass": "example", "isDeleted": true, "packageExternalId": "example", "packageId": "example", "packageName": "example", "requirementPackageId": "example", "ruEdo": {}, "shipmentBodyType": "example", "stackability": "example", "weight": 0.5 } ], "shipmentId": "example" } ]
tagId	Type: string \| null Тег заказа, например, "восток" Example: `example`
tagsInfo	Type: OrdersV0TransferOrderGetForEditTagInfo[] \| null Теги заказчика (информация о тегах) Example `[ { "code": "example", "name": "example" } ]`
temperatureRegime	Type: OrdersV0TransferOrderGetForEditTemperatureRegime[] \| null Температурный режим. Example `[ { "from": 0, "label": "example", "to": 0 } ]`
transferOrderAdditionalConditions	Type: string \| null Дополнительные условия заказа. Example: `example`
transferOrderCost	Any of 2 types Type: OrdersV0TransferOrderGetForEditPrice Example `{ "currency": "example", "price": 0.5 }` Type: object \| null Const: `null` Example `{}` Стоимость заказа. Example `{ "currency": "example", "price": 0.5 }`
transferOrderName	Type: string \| null Отображаемое имя заказа на перевозку. Example: `example`
transshipmentTypes	Type: string[] \| null Тип загрузки и выгрузки. Example `[ "example" ]`
typePaymentAndTax	Type: string \| null Тип оплаты платежа. Example: `example`
utm	Any of 2 types Type: OrdersV0TransferOrderGetForEditUTM Example `{ "utmCampaign": "example", "utmContent": "example", "utmMedium": "example", "utmSource": "example", "utmTerm": "example" }` Type: object \| null Const: `null` Example `{}` Utm информация. Example `{ "utmCampaign": "example", "utmContent": "example", "utmMedium": "example", "utmSource": "example", "utmTerm": "example" }`
volumeAuction	Any of 2 types Type: OrdersV0TransferOrderGetForEditVolumeAuction Example `{ "auctionType": "example", "duration": 0, "endDate": { "displayTZ": "+03:00", "time": "2020-01-01T00:00:00" }, "flightsCount": 0.5, "startDate": null, "tarifficationType": "example", "tonsCount": 0.5, "transitDistance": 0.5, "vehicleCapacityFrom": 0.5, "vehicleCapacityTo": 0.5 }` Type: object \| null Const: `null` Example `{}` Example `{ "auctionType": "example", "duration": 0, "endDate": { "displayTZ": "+03:00", "time": "2020-01-01T00:00:00" }, "flightsCount": 0.5, "startDate": null, "tarifficationType": "example", "tonsCount": 0.5, "transitDistance": 0.5, "vehicleCapacityFrom": 0.5, "vehicleCapacityTo": 0.5 }`

Example

{
  "agreementRules": {
    "isDriverCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangeShipmentsWithoutApproval": true,
    "isForwarderCanChangePackagesWithoutApproval": true,
    "isForwarderCanChangeShipmentsWithoutApproval": true,
    "isWarehouseCanChangePackagesWithoutApproval": true
  },
  "auction": {
    "allowMultimodal": true,
    "auctionType": "example",
    "autoExtension": true,
    "autoExtensionActive": 0,
    "autoExtensionDuration": 0,
    "autoExtensionTime": 0,
    "autoSelection": true,
    "bargainingIsPossible": true,
    "bidStep": 0.5,
    "buyNowPrice": 0.5,
    "decreaseOnly": true,
    "decreaseOnlyFromDeclaredPrice": true,
    "duration": 0,
    "endDate": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "hideBidsFromCarrier": true,
    "startDate": null,
    "tariffMatrixParams": {
      "isWhoFirst": true,
      "tariffMatrixIds": [
        null
      ]
    },
    "useTariffMatrix": true,
    "vat": 0.5,
    "vatAmount": 0.5,
    "vatInPriceNotConsider": true
  },
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "cargoCategory": {
    "category": "example",
    "categoryComment": "example"
  },
  "cargoComment": "example",
  "cargoId": "example",
  "currency": "example",
  "customer": {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerComment": "example",
    "customerCountry": "example",
    "customerForwarderId": "example",
    "customerForwarderTin": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example",
    "id": "example"
  },
  "dimensions": {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "palletCount": 0,
    "volume": 0.5,
    "weight": 0.5
  },
  "distribution": {
    "amount": 0.5,
    "comment": "example",
    "currency": "example",
    "dayDocClose": 0,
    "dayDocDelay": 0,
    "docFormat": "example",
    "groups": [
      {
        "id": "example",
        "name": "example"
      }
    ],
    "groupsId": [
      "example"
    ],
    "partners": [
      {
        "id": "example",
        "isBlackList": true,
        "name": "example",
        "tin": "example"
      }
    ],
    "publicMatcher": true,
    "type": "example",
    "typeDocClose": "example",
    "typeDocDelay": "example"
  },
  "files": [
    {
      "id": "example",
      "name": "example"
    }
  ],
  "forwarder": {
    "forwarderComment": "example",
    "forwarderId": "example",
    "forwarderTin": "example"
  },
  "freeTags": [
    "example"
  ],
  "id": "example",
  "isVolumeAuction": true,
  "paymentDelayPeriod": {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  },
  "shipments": [
    {
      "distributionPriority": 0,
      "isDeleted": true,
      "name": "example",
      "npShipment": {
        "content": "example",
        "country": "example",
        "legalAddress": "example",
        "legalPhone": "example",
        "name": "example",
        "nodalPointId": "example",
        "npAdditionalContact": [
          null
        ],
        "npGeoAddress": null,
        "npLegalType": "example",
        "npShipmentId": "example",
        "npTin": "example",
        "period": null,
        "phoneCountryCode": "example",
        "position": 0,
        "sequenceOrder": 0
      },
      "npUnshipment": null,
      "packageType": "example",
      "packages": [
        {
          "amount": 0.5,
          "capacity": 0.5,
          "count": 0,
          "currency": "example",
          "dimensionHeight": 0.5,
          "dimensionLength": 0.5,
          "dimensionWeight": 0.5,
          "hazardClass": "example",
          "isDeleted": true,
          "packageExternalId": "example",
          "packageId": "example",
          "packageName": "example",
          "requirementPackageId": "example",
          "ruEdo": null,
          "shipmentBodyType": "example",
          "stackability": "example",
          "weight": 0.5
        }
      ],
      "shipmentId": "example"
    }
  ],
  "status": "example",
  "tagId": "example",
  "tagsInfo": [
    {
      "code": "example",
      "name": "example"
    }
  ],
  "temperatureRegime": [
    {
      "from": 0,
      "label": "example",
      "to": 0
    }
  ],
  "transferOrderAdditionalConditions": "example",
  "transferOrderAdditionalConfiguration": {},
  "transferOrderCost": {
    "currency": "example",
    "price": 0.5
  },
  "transferOrderName": "example",
  "transferOrderType": "example",
  "transshipmentTypes": [
    "example"
  ],
  "typePaymentAndTax": "example",
  "utm": {
    "utmCampaign": "example",
    "utmContent": "example",
    "utmMedium": "example",
    "utmSource": "example",
    "utmTerm": "example"
  },
  "volumeAuction": {
    "auctionType": "example",
    "duration": 0,
    "endDate": null,
    "flightsCount": 0.5,
    "startDate": null,
    "tarifficationType": "example",
    "tonsCount": 0.5,
    "transitDistance": 0.5,
    "vehicleCapacityFrom": 0.5,
    "vehicleCapacityTo": 0.5
  }
}

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" }`

Получить полные карточки заказов исполнителя

Получить идентификаторы заказов заказчика

Получить заказ для редактирования

НазначениеНазначение

RequestRequest

Query parametersQuery parameters

ResponsesResponses

200 OK200 OK

BodyBody

OrdersV0TransferOrderGetForEditAgreementRulesOrdersV0TransferOrderGetForEditAgreementRules

TimestampTZOutputTimestampTZOutput

OrdersV0TransferOrderGetForEditTariffMatrixInfoOrdersV0TransferOrderGetForEditTariffMatrixInfo

OrdersV0TransferOrderGetForEditTariffMatrixParamsOrdersV0TransferOrderGetForEditTariffMatrixParams

OrdersV0TransferOrderGetForEditAuctionOrdersV0TransferOrderGetForEditAuction

OrdersV0TransferOrderGetForEditCargoCategoryOrdersV0TransferOrderGetForEditCargoCategory

OrdersV0TransferOrderGetForEditCustomerOrdersV0TransferOrderGetForEditCustomer

OrdersV0TransferOrderGetForEditDimensionsOrdersV0TransferOrderGetForEditDimensions

OrdersV0TransferOrderGetForEditGroupOrdersV0TransferOrderGetForEditGroup

OrdersV0TransferOrderGetForEditPartnerOrdersV0TransferOrderGetForEditPartner

OrdersV0TransferOrderGetForEditDistributionOrdersV0TransferOrderGetForEditDistribution

OrdersV0TransferOrderGetForEditForwarderOrdersV0TransferOrderGetForEditForwarder

OrdersV0TransferOrderGetForEditPaymentDelayPeriodOrdersV0TransferOrderGetForEditPaymentDelayPeriod

OrdersV0TransferOrderGetForEditNodalPointAdditionalContactOrdersV0TransferOrderGetForEditNodalPointAdditionalContact

OrdersV0TransferOrderGetForEditNpGeoAddressOrdersV0TransferOrderGetForEditNpGeoAddress

OrdersV0TransferOrderGetForEditNodalPointShipmentPeriodOrdersV0TransferOrderGetForEditNodalPointShipmentPeriod

OrdersV0TransferOrderGetForEditNodalPointShipmentOrdersV0TransferOrderGetForEditNodalPointShipment

OrdersV0TransferOrderGetForEditDangerousCargoOrdersV0TransferOrderGetForEditDangerousCargo

OrdersV0TransferOrderGetForEditPackagesRuEdoOrdersV0TransferOrderGetForEditPackagesRuEdo

OrdersV0TransferOrderGetForEditPackagesCreateOrdersV0TransferOrderGetForEditPackagesCreate

OrdersV0TransferOrderGetForEditShipmentCreateOrdersV0TransferOrderGetForEditShipmentCreate

OrdersV0TransferOrderGetForEditTagInfoOrdersV0TransferOrderGetForEditTagInfo

OrdersV0TransferOrderGetForEditTemperatureRegimeOrdersV0TransferOrderGetForEditTemperatureRegime

JSONObjectJSONObject

OrdersV0TransferOrderGetForEditPriceOrdersV0TransferOrderGetForEditPrice

OrdersV0TransferOrderGetForEditUTMOrdersV0TransferOrderGetForEditUTM

OrdersV0TransferOrderGetForEditVolumeAuctionOrdersV0TransferOrderGetForEditVolumeAuction

OrdersV0TransferOrderGetForEditResponseOrdersV0TransferOrderGetForEditResponse

400 Bad Request400 Bad Request

BodyBody

ErrorError

403 Forbidden403 Forbidden

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

Назначение

Request

Query parameters

Responses

200 OK

Body

OrdersV0TransferOrderGetForEditAgreementRules

TimestampTZOutput

OrdersV0TransferOrderGetForEditTariffMatrixInfo

OrdersV0TransferOrderGetForEditTariffMatrixParams

OrdersV0TransferOrderGetForEditAuction

OrdersV0TransferOrderGetForEditCargoCategory

OrdersV0TransferOrderGetForEditCustomer

OrdersV0TransferOrderGetForEditDimensions

OrdersV0TransferOrderGetForEditGroup

OrdersV0TransferOrderGetForEditPartner

OrdersV0TransferOrderGetForEditDistribution

OrdersV0TransferOrderGetForEditForwarder

OrdersV0TransferOrderGetForEditPaymentDelayPeriod

OrdersV0TransferOrderGetForEditNodalPointAdditionalContact

OrdersV0TransferOrderGetForEditNpGeoAddress

OrdersV0TransferOrderGetForEditNodalPointShipmentPeriod

OrdersV0TransferOrderGetForEditNodalPointShipment

OrdersV0TransferOrderGetForEditDangerousCargo

OrdersV0TransferOrderGetForEditPackagesRuEdo

OrdersV0TransferOrderGetForEditPackagesCreate

OrdersV0TransferOrderGetForEditShipmentCreate

OrdersV0TransferOrderGetForEditTagInfo

OrdersV0TransferOrderGetForEditTemperatureRegime

JSONObject

OrdersV0TransferOrderGetForEditPrice

OrdersV0TransferOrderGetForEditUTM

OrdersV0TransferOrderGetForEditVolumeAuction

OrdersV0TransferOrderGetForEditResponse

400 Bad Request

Body

Error

403 Forbidden

Body

500 Internal Server Error

Body