---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
vcsPath: >-
  motorway/magacg/support/docs/src/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md
alternate:
  - href: >-
      https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md
    type: text/markdown
    title: Markdown version
  - href: https://yamagistrali.ru/docs/ru-x-ai/llms.txt
    rel: describedby
---
<div class="openapi">

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

<!-- markdownlint-disable-file -->

[Порядок работы для агента](https://yamagistrali.ru/docs/ru-x-ai/concepts/agent-workflow.md) · [Методы API и схема OpenAPI](https://yamagistrali.ru/docs/ru-x-ai/methods/index.md).

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

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

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

## Request

<div class="openapi__requests">

<div class="openapi__request__wrapper" style="--method: var(--dc-openapi-methods-get);margin-bottom: 12px">

<div class="openapi__request">

GET {.openapi__method}
```text translate=no
https://partner-test-yamagistrali.ru/api/orders/v0/transferOrder/getForEdit
```

</div>

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

</div>

</div>

### Query parameters

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} ``
{.table-cell}
||
|#{.json-schema-properties}

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "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
    }
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_data_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditResponse](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditResponse)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
  }
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditAgreementRules {#entity-OrdersV0TransferOrderGetForEditAgreementRules}

#|
|| **Name** | **Description** ||
||

_isDriverCanChangePackagesWithoutApproval_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Может ли водитель менять места в заказе без согласования
{.table-cell}
||
||

_isExecutorCanChangePackagesWithoutApproval_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Может ли исполнитель менять места в заказе без согласования
{.table-cell}
||
||

_isExecutorCanChangeShipmentsWithoutApproval_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Может ли исполнитель менять грузы в заказе без согласования
{.table-cell}
||
||

_isForwarderCanChangePackagesWithoutApproval_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Может ли заказчик менять места в заказе без согласования
{.table-cell}
||
||

_isForwarderCanChangeShipmentsWithoutApproval_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Может ли заказчик менять грузы в заказе без согласования
{.table-cell}
||
||

_isWarehouseCanChangePackagesWithoutApproval_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Может ли склад менять места в заказе без согласования
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### TimestampTZOutput {#entity-TimestampTZOutput}

#|
|| **Name** | **Description** ||
||

_displayTZ_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `+03:00`
{.table-cell}
||
||

_time_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string&lt;date-time&gt;

_Example:_{.json-schema-reset .json-schema-example} `2020-01-01T00:00:00`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditTariffMatrixInfo {#entity-OrdersV0TransferOrderGetForEditTariffMatrixInfo}

#|
|| **Name** | **Description** ||
||

_tariffMatrixId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "tariffMatrixId": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditTariffMatrixParams {#entity-OrdersV0TransferOrderGetForEditTariffMatrixParams}

#|
|| **Name** | **Description** ||
||

_isWhoFirst_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Торговля по принципу кто первый
{.table-cell}
||
||

_tariffMatrixIds_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditTariffMatrixInfo](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditTariffMatrixInfo)[] &#124; null

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "tariffMatrixId": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "isWhoFirst": true,
  "tariffMatrixIds": [
    {
      "tariffMatrixId": "example"
    }
  ]
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditAuction {#entity-OrdersV0TransferOrderGetForEditAuction}

#|
|| **Name** | **Description** ||
||

_allowMultimodal_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Разрешить мультимодальный торг
{.table-cell}
||
||

_auctionType_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

тип торгов

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_autoExtension_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Автопродление
{.table-cell}
||
||

_autoExtensionActive_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Время Активации автопродления в сеуундах
{.table-cell}
||
||

_autoExtensionDuration_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Максимальное длительность продления в секундах
{.table-cell}
||
||

_autoExtensionTime_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Время продления в секундах
{.table-cell}
||
||

_autoSelection_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Автовыбор
{.table-cell}
||
||

_bargainingIsPossible_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

торг возможен
{.table-cell}
||
||

_decreaseOnly_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Только на понижение
{.table-cell}
||
||

_decreaseOnlyFromDeclaredPrice_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Только на понижение от заданной цены
{.table-cell}
||
||

_duration_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Длительность торгов в секундах
{.table-cell}
||
||

_hideBidsFromCarrier_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Скрывать ставки от исполнителя
{.table-cell}
||
||

_useTariffMatrix_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

Торги Тарифная матрица
{.table-cell}
||
||

_vatInPriceNotConsider_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

без учёта НДС
{.table-cell}
||
||

_bidStep_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Шаг торгов
{.table-cell}
||
||

_buyNowPrice_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

«Buy now» (input - число)
{.table-cell}
||
||

_endDate_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-TimestampTZOutput)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

Дата окончания

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
```

{% endcut %}
{.table-cell}
||
||

_startDate_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-TimestampTZOutput)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

Дата начала (опциональное)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
```

{% endcut %}
{.table-cell}
||
||

_tariffMatrixParams_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditTariffMatrixParams](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditTariffMatrixParams)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "isWhoFirst": true,
    "tariffMatrixIds": [
      {
        "tariffMatrixId": "example"
      }
    ]
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

Параметры Тарифной матрицы

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "isWhoFirst": true,
  "tariffMatrixIds": [
    {
      "tariffMatrixId": "example"
    }
  ]
}
```

{% endcut %}
{.table-cell}
||
||

_vat_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

НДС Distribution.amount (опциональное)
{.table-cell}
||
||

_vatAmount_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

НДС Distribution.amount (опциональное)
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditCargoCategory {#entity-OrdersV0TransferOrderGetForEditCargoCategory}

#|
|| **Name** | **Description** ||
||

_category_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Тип груза.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_categoryComment_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "category": "example",
  "categoryComment": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditCustomer {#entity-OrdersV0TransferOrderGetForEditCustomer}

#|
|| **Name** | **Description** ||
||

_customerAddress_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_customerComment_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_customerCountry_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_customerForwarderId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Идентификатор организации владельца груза в роли заказчика

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_customerLegalForm_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_customerName_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_customerPhone_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_customerTin_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_customerCargoPrice_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

стоимость груза в блоке заказчика
{.table-cell}
||
||

_customerForwarderTin_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerForwarderTin": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example",
  "id": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditDimensions {#entity-OrdersV0TransferOrderGetForEditDimensions}

#|
|| **Name** | **Description** ||
||

_breadth_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Ширина с точностью до 2х знактов.
{.table-cell}
||
||

_height_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Высота с точностью до 2х знактов.
{.table-cell}
||
||

_length_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Длина с точностью до 2х знактов.
{.table-cell}
||
||

_palletCount_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer &#124; null

Количество палет.
{.table-cell}
||
||

_volume_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Объём с точностью до 3х знактов.
{.table-cell}
||
||

_weight_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Вес в КГ.
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "palletCount": 0,
  "volume": 0.5,
  "weight": 0.5
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditGroup {#entity-OrdersV0TransferOrderGetForEditGroup}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "name": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditPartner {#entity-OrdersV0TransferOrderGetForEditPartner}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_isBlackList_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_tin_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "isBlackList": true,
  "name": "example",
  "tin": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditDistribution {#entity-OrdersV0TransferOrderGetForEditDistribution}

#|
|| **Name** | **Description** ||
||

_comment_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_currency_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_dayDocClose_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Количество дней до закрытия документа, например, 2
{.table-cell}
||
||

_dayDocDelay_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Количество дней задержки документа, например, 3
{.table-cell}
||
||

_docFormat_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_publicMatcher_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean

открытый аукцион или нет
{.table-cell}
||
||

_type_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_typeDocClose_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_typeDocDelay_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_amount_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Заявленная стоимость торгов (Сумма, например, 123)
{.table-cell}
||
||

_groups_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditGroup](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditGroup)[] &#124; null

Группы, связанные с определением исполнителя

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "name": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_groupsId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[] &#124; null

Группы, связанные с определением исполнителя (пока неизвестно, что конкретно будет в этом массиве)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_partners_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditPartner](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditPartner)[] &#124; null

Исполнители

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "isBlackList": true,
    "name": "example",
    "tin": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditForwarder {#entity-OrdersV0TransferOrderGetForEditForwarder}

#|
|| **Name** | **Description** ||
||

_forwarderId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Идентификатор заказчика в сервисе Яндекс Магистрали

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_forwarderComment_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_forwarderTin_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

ИНН заказчика

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "forwarderComment": "example",
  "forwarderId": "example",
  "forwarderTin": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditPaymentDelayPeriod {#entity-OrdersV0TransferOrderGetForEditPaymentDelayPeriod}

#|
|| **Name** | **Description** ||
||

_paymentType_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Тип оплаты.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_daysDelayPeriod_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer &#124; null

Количество дней отсрочки платяжа.
{.table-cell}
||
||

_postPayCalendarType_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "daysDelayPeriod": 0,
  "paymentType": "example",
  "postPayCalendarType": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditNodalPointAdditionalContact {#entity-OrdersV0TransferOrderGetForEditNodalPointAdditionalContact}

#|
|| **Name** | **Description** ||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_npcName_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_npcPhone_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_npcExternalId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "id": "example",
  "npcExternalId": "example",
  "npcName": "example",
  "npcPhone": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditNpGeoAddress {#entity-OrdersV0TransferOrderGetForEditNpGeoAddress}

#|
|| **Name** | **Description** ||
||

_address_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_lat_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number
{.table-cell}
||
||

_locality_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_long_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number
{.table-cell}
||
||

_province_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "address": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "province": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditNodalPointShipmentPeriod {#entity-OrdersV0TransferOrderGetForEditNodalPointShipmentPeriod}

#|
|| **Name** | **Description** ||
||

_from_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-TimestampTZOutput)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
```

{% endcut %}
{.table-cell}
||
||

_to_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-TimestampTZOutput)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "to": null
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditNodalPointShipment {#entity-OrdersV0TransferOrderGetForEditNodalPointShipment}

#|
|| **Name** | **Description** ||
||

_content_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_country_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_nodalPointId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_npGeoAddress_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Type**: [OrdersV0TransferOrderGetForEditNpGeoAddress](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditNpGeoAddress)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "address": "example",
    "lat": 0.5,
    "locality": "example",
    "long": 0.5,
    "province": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "address": "example",
  "lat": 0.5,
  "locality": "example",
  "long": 0.5,
  "province": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_npLegalType_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_npTin_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_period_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Type**: [OrdersV0TransferOrderGetForEditNodalPointShipmentPeriod](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditNodalPointShipmentPeriod)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "from": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "to": null
  }
  ```

  {% endcut %}

{% endcut %}

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "to": null
}
```

{% endcut %}
{.table-cell}
||
||

_phoneCountryCode_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Идентификатор страны телефона контактного лица.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_position_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

очередь разгрузки/погрузки.
{.table-cell}
||
||

_legalAddress_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_legalPhone_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_npAdditionalContact_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditNodalPointAdditionalContact](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditNodalPointAdditionalContact)[] &#124; null

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "npcExternalId": "example",
    "npcName": "example",
    "npcPhone": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_npShipmentId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_sequenceOrder_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer &#124; null
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditDangerousCargo {#entity-OrdersV0TransferOrderGetForEditDangerousCargo}

#|
|| **Name** | **Description** ||
||

_hazardClass_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_classificationCode_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_competentAuthoritySign_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_controlTemperature_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_description_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_emergencyTemperature_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_explosiveNetMass_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_explosiveNetMassTotal_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_hazardLabel_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_holdTimeExpiryDate_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `2006-01-02T00:00:00Z`
{.table-cell}
||
||

_maxActivity_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_mixtureCompositionPercent_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_packageCategory_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_packingGroup_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_physicalChemicalDescription_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_properShippingName_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_radionuclideName_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_regulatoryAct_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_safetyIndex_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_technicalName_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_totalActivity_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_transportIndex_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_tunnelRestrictionCode_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_unHazardId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditPackagesRuEdo {#entity-OrdersV0TransferOrderGetForEditPackagesRuEdo}

#|
|| **Name** | **Description** ||
||

_cargoState_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

состояние груза

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_codeToVNom_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

код товарной номенклатуры

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_dangerousCargo_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditDangerousCargo](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditDangerousCargo)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "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"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

сведения об опасном грузе

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}
{.table-cell}
||
||

_mark_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[] &#124; null

маркировка

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_pkgType_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

тип упаковки

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditPackagesCreate {#entity-OrdersV0TransferOrderGetForEditPackagesCreate}

#|
|| **Name** | **Description** ||
||

_count_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Количество
{.table-cell}
||
||

_hazardClass_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_isDeleted_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
||

_packageId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_stackability_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_amount_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Объявленная стоимость
{.table-cell}
||
||

_capacity_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Объем
{.table-cell}
||
||

_currency_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

Валюта

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_dimensionHeight_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null
{.table-cell}
||
||

_dimensionLength_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null
{.table-cell}
||
||

_dimensionWeight_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null
{.table-cell}
||
||

_packageExternalId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_packageName_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_requirementPackageId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_ruEdo_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditPackagesRuEdo](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditPackagesRuEdo)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "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"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

Данные для Российского ЭДО

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}
{.table-cell}
||
||

_shipmentBodyType_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_weight_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null

Вес
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditShipmentCreate {#entity-OrdersV0TransferOrderGetForEditShipmentCreate}

#|
|| **Name** | **Description** ||
||

_isDeleted_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_npShipment_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Type**: [OrdersV0TransferOrderGetForEditNodalPointShipment](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditNodalPointShipment)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "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
  }
  ```

  {% endcut %}

{% endcut %}

Погрузка

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}
{.table-cell}
||
||

_npUnshipment_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Type**: [OrdersV0TransferOrderGetForEditNodalPointShipment](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditNodalPointShipment)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "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
  }
  ```

  {% endcut %}

{% endcut %}

Разгрузка

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}
{.table-cell}
||
||

_packageType_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_shipmentId_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_distributionPriority_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: integer &#124; null
{.table-cell}
||
||

_packages_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditPackagesCreate](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditPackagesCreate)[] &#124; null

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "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
  }
]
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditTagInfo {#entity-OrdersV0TransferOrderGetForEditTagInfo}

#|
|| **Name** | **Description** ||
||

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_name_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "code": "example",
  "name": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditTemperatureRegime {#entity-OrdersV0TransferOrderGetForEditTemperatureRegime}

#|
|| **Name** | **Description** ||
||

_from_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Температура градусов в цельсиях, минимум.
{.table-cell}
||
||

_to_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer

Температура градусов в цельсиях, максимум.
{.table-cell}
||
||

_label_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

Метка температурного режима.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "from": 0,
  "label": "example",
  "to": 0
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### JSONObject {#entity-JSONObject}

**Type**: object

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditPrice {#entity-OrdersV0TransferOrderGetForEditPrice}

#|
|| **Name** | **Description** ||
||

_currency_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

Валюта.

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_price_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number

Цена с точностью до 2х знаков.
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "currency": "example",
  "price": 0.5
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditUTM {#entity-OrdersV0TransferOrderGetForEditUTM}

#|
|| **Name** | **Description** ||
||

_utmSource_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_utmCampaign_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_utmContent_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_utmMedium_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_utmTerm_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditVolumeAuction {#entity-OrdersV0TransferOrderGetForEditVolumeAuction}

#|
|| **Name** | **Description** ||
||

_auctionType_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_duration_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: integer
{.table-cell}
||
||

_tarifficationType_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_transitDistance_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number
{.table-cell}
||
||

_endDate_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-TimestampTZOutput)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
```

{% endcut %}
{.table-cell}
||
||

_flightsCount_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null
{.table-cell}
||
||

_startDate_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-TimestampTZOutput)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "displayTZ": "+03:00",
  "time": "2020-01-01T00:00:00"
}
```

{% endcut %}
{.table-cell}
||
||

_tonsCount_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null
{.table-cell}
||
||

_vehicleCapacityFrom_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null
{.table-cell}
||
||

_vehicleCapacityTo_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: number &#124; null
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrdersV0TransferOrderGetForEditResponse {#entity-OrdersV0TransferOrderGetForEditResponse}

#|
|| **Name** | **Description** ||
||

_bodyTypeComment_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_cargoCategory_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Type**: [OrdersV0TransferOrderGetForEditCargoCategory](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditCargoCategory)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "category": "example",
    "categoryComment": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "category": "example",
  "categoryComment": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_currency_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_customer_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Type**: [OrdersV0TransferOrderGetForEditCustomer](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditCustomer)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "customerAddress": "example",
    "customerCargoPrice": 0.5,
    "customerComment": "example",
    "customerCountry": "example",
    "customerForwarderId": "example",
    "customerForwarderTin": "example",
    "customerLegalForm": "example",
    "customerName": "example",
    "customerPhone": "example",
    "customerTin": "example",
    "id": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "customerAddress": "example",
  "customerCargoPrice": 0.5,
  "customerComment": "example",
  "customerCountry": "example",
  "customerForwarderId": "example",
  "customerForwarderTin": "example",
  "customerLegalForm": "example",
  "customerName": "example",
  "customerPhone": "example",
  "customerTin": "example",
  "id": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_forwarder_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
{% cut "**All of 1 type**" %}{.json-schema-combinators data-marker=and}

- **Type**: [OrdersV0TransferOrderGetForEditForwarder](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditForwarder)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "forwarderComment": "example",
    "forwarderId": "example",
    "forwarderTin": "example"
  }
  ```

  {% endcut %}

{% endcut %}

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "forwarderComment": "example",
  "forwarderId": "example",
  "forwarderTin": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_id_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_isVolumeAuction_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: boolean
{.table-cell}
||
||

_status_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_transferOrderAdditionalConfiguration_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [JSONObject](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-JSONObject)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
||

_transferOrderType_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: string

FTL LTL

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_agreementRules_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditAgreementRules](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditAgreementRules)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "isDriverCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangePackagesWithoutApproval": true,
    "isExecutorCanChangeShipmentsWithoutApproval": true,
    "isForwarderCanChangePackagesWithoutApproval": true,
    "isForwarderCanChangeShipmentsWithoutApproval": true,
    "isWarehouseCanChangePackagesWithoutApproval": true
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

Правила согласования

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "isDriverCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangePackagesWithoutApproval": true,
  "isExecutorCanChangeShipmentsWithoutApproval": true,
  "isForwarderCanChangePackagesWithoutApproval": true,
  "isForwarderCanChangeShipmentsWithoutApproval": true,
  "isWarehouseCanChangePackagesWithoutApproval": true
}
```

{% endcut %}
{.table-cell}
||
||

_auction_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditAuction](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditAuction)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "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
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}
{.table-cell}
||
||

_bodyType_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[] &#124; null

Тип кузова.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_cargoComment_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_cargoId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_dimensions_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditDimensions](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditDimensions)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "breadth": 0.5,
    "height": 0.5,
    "length": 0.5,
    "palletCount": 0,
    "volume": 0.5,
    "weight": 0.5
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

Вес и объём.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "breadth": 0.5,
  "height": 0.5,
  "length": 0.5,
  "palletCount": 0,
  "volume": 0.5,
  "weight": 0.5
}
```

{% endcut %}
{.table-cell}
||
||

_distribution_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditDistribution](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditDistribution)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "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"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

Тип опредения исполнителя.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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"
}
```

{% endcut %}
{.table-cell}
||
||

_files_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditFiles](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditFiles)[] &#124; null

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "id": "example",
    "name": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_freeTags_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[] &#124; null

Теги заказчика

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_paymentDelayPeriod_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditPaymentDelayPeriod](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditPaymentDelayPeriod)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "daysDelayPeriod": 0,
    "paymentType": "example",
    "postPayCalendarType": "example"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "daysDelayPeriod": 0,
  "paymentType": "example",
  "postPayCalendarType": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_shipments_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditShipmentCreate](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditShipmentCreate)[] &#124; null

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "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"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_tagId_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

Тег заказа, например, "восток"

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_tagsInfo_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditTagInfo](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditTagInfo)[] &#124; null

Теги заказчика (информация о тегах)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "code": "example",
    "name": "example"
  }
]
```

{% endcut %}
{.table-cell}
||
||

_temperatureRegime_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [OrdersV0TransferOrderGetForEditTemperatureRegime](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditTemperatureRegime)[] &#124; null

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  {
    "from": 0,
    "label": "example",
    "to": 0
  }
]
```

{% endcut %}
{.table-cell}
||
||

_transferOrderAdditionalConditions_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_transferOrderCost_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditPrice](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditPrice)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "currency": "example",
    "price": 0.5
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "currency": "example",
  "price": 0.5
}
```

{% endcut %}
{.table-cell}
||
||

_transferOrderName_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_transshipmentTypes_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string[] &#124; null

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

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
[
  "example"
]
```

{% endcut %}
{.table-cell}
||
||

_typePaymentAndTax_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string &#124; null

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

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_utm_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditUTM](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditUTM)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "utmCampaign": "example",
    "utmContent": "example",
    "utmMedium": "example",
    "utmSource": "example",
    "utmTerm": "example"
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

Utm информация.

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "utmCampaign": "example",
  "utmContent": "example",
  "utmMedium": "example",
  "utmSource": "example",
  "utmTerm": "example"
}
```

{% endcut %}
{.table-cell}
||
||

_volumeAuction_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Any of 2 types**" %}{.json-schema-combinators data-marker=or}

- **Type**: [OrdersV0TransferOrderGetForEditVolumeAuction](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-OrdersV0TransferOrderGetForEditVolumeAuction)

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {
    "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
  }
  ```

  {% endcut %}

- **Type**: object &#124; null

  _Const:_{.json-schema-reset .json-schema-value} `null`

  {% cut "**Example**" %}{.json-schema-example}

  ```json translate=no
  {}
  ```

  {% endcut %}

{% endcut %}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "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
  }
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Bad Request

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_error_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Error](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-Error)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### Error {#entity-Error}

#|
|| **Name** | **Description** ||
||

_info_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: object

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{}
```

{% endcut %}
{.table-cell}
||
||

_message_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
||

_message_code_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `example`
{.table-cell}
||
|#{.json-schema-properties}

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}

</div>

</div>

<div class="openapi__response__code__403">

## 403 Forbidden

Forbidden

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_error_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Error](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-Error)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

<div class="openapi__response__code__500">

## 500 Internal Server Error

Internal Server Error

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "error": {
    "info": {},
    "message": "example",
    "message_code": "example"
  }
}
```

{% endcut %}

#|
|| **Name** | **Description** ||
||

_error_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Error](https://yamagistrali.ru/docs/ru-x-ai/methods/get-api-orders-v0-transferorder-getforedit.md#entity-Error)

{% cut "**Example**" %}{.json-schema-example}

```json translate=no
{
  "info": {},
  "message": "example",
  "message_code": "example"
}
```

{% endcut %}
{.table-cell}
||
|#{.json-schema-properties}

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.