---
metadata:
  - name: generator
    content: Diplodoc Platform v5.70.0
vcsPath: >-
  motorway/magacg/support/docs/src/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md
alternate:
  - href: >-
      https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.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).

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

Получите торги заказчика. Найдите запись по `orderId` в `data.items` и проверьте `canChooseWinner` и `isAutoAuction` перед выбором победителя.

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

## Request

<div class="openapi__requests">

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

<div class="openapi__request">

POST {.openapi__method}
```text translate=no
https://partner-test-yamagistrali.ru/api/demand/listForForwarder/v0
```

</div>

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

</div>

</div>

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "data": {}
}
```

{% endcut %}

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

_data_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DemandListForForwarderV0Request](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-DemandListForForwarderV0Request)

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

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

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

</div>

<div class="openapi-entity">

### DemandListForForwarderV0Request {#entity-DemandListForForwarderV0Request}

**Type**: object

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

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

{% endcut %}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "data": {
    "items": [
      {
        "agreementTerms": {},
        "auction": null,
        "betCount": 0,
        "bodyType": [
          "example"
        ],
        "bodyTypeComment": "example",
        "canChooseWinner": true,
        "cargoType": "example",
        "cargoTypeComment": "example",
        "createAt": {
          "displayTZ": "+03:00",
          "time": "2020-01-01T00:00:00"
        },
        "creatorUser": "example",
        "declaredCost": 0.5,
        "demandStoreState": "example",
        "demandVirtualState": "example",
        "editorUsers": [
          "example"
        ],
        "extId": "example",
        "forwarderId": "example",
        "fromNp": {
          "address": "example",
          "comeTill": null,
          "comeWith": null,
          "comment": "example",
          "lat": 0.5,
          "loadingTime": 0,
          "locality": "example",
          "lon": 0.5,
          "nodalPointId": "example",
          "npLegalType": "example"
        },
        "id": "example",
        "isAutoAuction": true,
        "isUseMobileApp": true,
        "loadingType": [
          "example"
        ],
        "medList": [
          null
        ],
        "minBetCost": 0.5,
        "observerUsers": [
          "example"
        ],
        "orderId": "example",
        "orderType": "example",
        "pallets": 0,
        "possibleBetCount": 0,
        "possibleExecutorIds": [
          "example"
        ],
        "specialConditions": "example",
        "temperatureFrom": 0,
        "temperatureTo": 0,
        "toNp": null,
        "updateAt": null,
        "volume": 0.5,
        "weight": 0.5,
        "winnerExecuteId": "example"
      }
    ]
  }
}
```

{% endcut %}

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

_data_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DemandListForForwarderV0Response](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-DemandListForForwarderV0Response)

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

```json translate=no
{
  "items": [
    {
      "agreementTerms": {
        "deferredPaymentDays": 0,
        "documentFormat": "example",
        "freeCancellationTime": 0,
        "idleHourCost": 0.5,
        "idleIncludedTariff": 0.5,
        "isFactoring": true,
        "isPrepayment": true,
        "paymentType": "example",
        "penaltyCancellation": 0.5,
        "penaltyForBeingLate": 0.5,
        "penaltyForProvidingDocuments": 0.5,
        "postponementDocumentSubmission": 0
      },
      "auction": {
        "cost": 0.5,
        "endDateTime": null,
        "exchange": "example",
        "isDowngradeOnly": true,
        "isInProgress": true,
        "isNoHigherMine": true,
        "startDateTime": null,
        "step": 0.5
      },
      "betCount": 0,
      "bodyType": [
        "example"
      ],
      "bodyTypeComment": "example",
      "canChooseWinner": true,
      "cargoType": "example",
      "cargoTypeComment": "example",
      "createAt": {
        "displayTZ": "+03:00",
        "time": "2020-01-01T00:00:00"
      },
      "creatorUser": "example",
      "declaredCost": 0.5,
      "demandStoreState": "example",
      "demandVirtualState": "example",
      "editorUsers": [
        "example"
      ],
      "extId": "example",
      "forwarderId": "example",
      "fromNp": {
        "address": "example",
        "comeTill": null,
        "comeWith": null,
        "comment": "example",
        "lat": 0.5,
        "loadingTime": 0,
        "locality": "example",
        "lon": 0.5,
        "nodalPointId": "example",
        "npLegalType": "example"
      },
      "id": "example",
      "isAutoAuction": true,
      "isUseMobileApp": true,
      "loadingType": [
        "example"
      ],
      "medList": [
        null
      ],
      "minBetCost": 0.5,
      "observerUsers": [
        "example"
      ],
      "orderId": "example",
      "orderType": "example",
      "pallets": 0,
      "possibleBetCount": 0,
      "possibleExecutorIds": [
        "example"
      ],
      "specialConditions": "example",
      "temperatureFrom": 0,
      "temperatureTo": 0,
      "toNp": null,
      "updateAt": null,
      "volume": 0.5,
      "weight": 0.5,
      "winnerExecuteId": "example"
    }
  ]
}
```

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

</div>

<div class="openapi-entity">

### DemandAgreementTerms {#entity-DemandAgreementTerms}

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

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

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

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

формат документов( скан; оригинал; подписанная копия)

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

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

время бесплатной отмены
{.table-cell}
||
||

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

стоимость 1ч простоя
{.table-cell}
||
||

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

простой включенный в тариф
{.table-cell}
||
||

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

факторинг
{.table-cell}
||
||

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

постоплата/предоплата
{.table-cell}
||
||

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

наличка/безнал/биилинг

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

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

штраф за отмену
{.table-cell}
||
||

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

Штрафы за опоздание (минуты)
{.table-cell}
||
||

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

Штрафы за предоставление документов
{.table-cell}
||
||

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

кол-во дней отстрочки предоставления документов
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "deferredPaymentDays": 0,
  "documentFormat": "example",
  "freeCancellationTime": 0,
  "idleHourCost": 0.5,
  "idleIncludedTariff": 0.5,
  "isFactoring": true,
  "isPrepayment": true,
  "paymentType": "example",
  "penaltyCancellation": 0.5,
  "penaltyForBeingLate": 0.5,
  "penaltyForProvidingDocuments": 0.5,
  "postponementDocumentSubmission": 0
}
```

{% 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">

### DemandAuctionResponse {#entity-DemandAuctionResponse}

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

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

- **Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-TimestampTZOutput)

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

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

  {% endcut %}

{% endcut %}

окончание дата + время

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

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

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

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

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

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

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

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

в процессе (вычисляемое поле)
{.table-cell}
||
||

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

не выше моей bool
{.table-cell}
||
||

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

- **Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-TimestampTZOutput)

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

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

  {% endcut %}

{% endcut %}

начало дата + время

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

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

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

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

стоимость
{.table-cell}
||
||

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

шаг/кратность int (default 1)
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "cost": 0.5,
  "endDateTime": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "exchange": "example",
  "isDowngradeOnly": true,
  "isInProgress": true,
  "isNoHigherMine": true,
  "startDateTime": null,
  "step": 0.5
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DemandPointResponse {#entity-DemandPointResponse}

#|
|| **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}
||
||

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

- **Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-TimestampTZOutput)

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

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

  {% endcut %}

{% endcut %}

Приехать ПО (дата + время)

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

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

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

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

- **Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-TimestampTZOutput)

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

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

  {% endcut %}

{% endcut %}

Приехать С (дата + время)

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

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

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

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

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

Время погрузоразгрузочных работ напрмер 146 минут
{.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}
||
||

_lon_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: number
{.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}
||
||

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

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

_comment_{.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
{
  "address": "example",
  "comeTill": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "comeWith": null,
  "comment": "example",
  "lat": 0.5,
  "loadingTime": 0,
  "locality": "example",
  "lon": 0.5,
  "nodalPointId": "example",
  "npLegalType": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DemandListForForwarderV0Demand {#entity-DemandListForForwarderV0Demand}

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

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

- **Type**: [DemandAuctionResponse](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-DemandAuctionResponse)

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

  ```json translate=no
  {
    "cost": 0.5,
    "endDateTime": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "exchange": "example",
    "isDowngradeOnly": true,
    "isInProgress": true,
    "isNoHigherMine": true,
    "startDateTime": null,
    "step": 0.5
  }
  ```

  {% endcut %}

{% endcut %}

торги

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

```json translate=no
{
  "cost": 0.5,
  "endDateTime": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "exchange": "example",
  "isDowngradeOnly": true,
  "isInProgress": true,
  "isNoHigherMine": true,
  "startDateTime": null,
  "step": 0.5
}
```

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

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

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

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

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

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

тип груза

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

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

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

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

_createAt_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-TimestampTZOutput)

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

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

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

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

автор/владелец; автор ставки;

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

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

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

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

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

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

внешний id/ id

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

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

заказчик услуги

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

_fromNp_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DemandPointResponse](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-DemandPointResponse)

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

```json translate=no
{
  "address": "example",
  "comeTill": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "comeWith": null,
  "comment": "example",
  "lat": 0.5,
  "loadingTime": 0,
  "locality": "example",
  "lon": 0.5,
  "nodalPointId": "example",
  "npLegalType": "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}
||
||

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

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

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

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

название грузоместа (?) - только у заказчика order_id

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

_orderType_{.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}
||
||

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

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

особые условия поле для включения в договор text

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

_toNp_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [DemandPointResponse](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-DemandPointResponse)

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

```json translate=no
{
  "address": "example",
  "comeTill": {
    "displayTZ": "+03:00",
    "time": "2020-01-01T00:00:00"
  },
  "comeWith": null,
  "comment": "example",
  "lat": 0.5,
  "loadingTime": 0,
  "locality": "example",
  "lon": 0.5,
  "nodalPointId": "example",
  "npLegalType": "example"
}
```

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

_updateAt_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [TimestampTZOutput](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-TimestampTZOutput)

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

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

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

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

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

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

- **Type**: [DemandAgreementTerms](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-DemandAgreementTerms)

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

  ```json translate=no
  {
    "deferredPaymentDays": 0,
    "documentFormat": "example",
    "freeCancellationTime": 0,
    "idleHourCost": 0.5,
    "idleIncludedTariff": 0.5,
    "isFactoring": true,
    "isPrepayment": true,
    "paymentType": "example",
    "penaltyCancellation": 0.5,
    "penaltyForBeingLate": 0.5,
    "penaltyForProvidingDocuments": 0.5,
    "postponementDocumentSubmission": 0
  }
  ```

  {% 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
{
  "deferredPaymentDays": 0,
  "documentFormat": "example",
  "freeCancellationTime": 0,
  "idleHourCost": 0.5,
  "idleIncludedTariff": 0.5,
  "isFactoring": true,
  "isPrepayment": true,
  "paymentType": "example",
  "penaltyCancellation": 0.5,
  "penaltyForBeingLate": 0.5,
  "penaltyForProvidingDocuments": 0.5,
  "postponementDocumentSubmission": 0
}
```

{% 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}
||
||

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

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

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

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

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

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

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

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

тип погрузки

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

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

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

_medList_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DemandPointResponse](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-DemandPointResponse)[] &#124; null

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

```json translate=no
[
  {
    "address": "example",
    "comeTill": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "comeWith": null,
    "comment": "example",
    "lat": 0.5,
    "loadingTime": 0,
    "locality": "example",
    "lon": 0.5,
    "nodalPointId": "example",
    "npLegalType": "example"
  }
]
```

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

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

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

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

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

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

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

вес и объем вместимости тс (палетность (опц))
{.table-cell}
||
||

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

Идентификаторы возможных исполнителей

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

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

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

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

Температура от
{.table-cell}
||
||

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

Температура до
{.table-cell}
||
||

_winnerExecuteId_{.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
{
  "agreementTerms": {
    "deferredPaymentDays": 0,
    "documentFormat": "example",
    "freeCancellationTime": 0,
    "idleHourCost": 0.5,
    "idleIncludedTariff": 0.5,
    "isFactoring": true,
    "isPrepayment": true,
    "paymentType": "example",
    "penaltyCancellation": 0.5,
    "penaltyForBeingLate": 0.5,
    "penaltyForProvidingDocuments": 0.5,
    "postponementDocumentSubmission": 0
  },
  "auction": {
    "cost": 0.5,
    "endDateTime": {
      "displayTZ": "+03:00",
      "time": "2020-01-01T00:00:00"
    },
    "exchange": "example",
    "isDowngradeOnly": true,
    "isInProgress": true,
    "isNoHigherMine": true,
    "startDateTime": null,
    "step": 0.5
  },
  "betCount": 0,
  "bodyType": [
    "example"
  ],
  "bodyTypeComment": "example",
  "canChooseWinner": true,
  "cargoType": "example",
  "cargoTypeComment": "example",
  "createAt": null,
  "creatorUser": "example",
  "declaredCost": 0.5,
  "demandStoreState": "example",
  "demandVirtualState": "example",
  "editorUsers": [
    "example"
  ],
  "extId": "example",
  "forwarderId": "example",
  "fromNp": {
    "address": "example",
    "comeTill": null,
    "comeWith": null,
    "comment": "example",
    "lat": 0.5,
    "loadingTime": 0,
    "locality": "example",
    "lon": 0.5,
    "nodalPointId": "example",
    "npLegalType": "example"
  },
  "id": "example",
  "isAutoAuction": true,
  "isUseMobileApp": true,
  "loadingType": [
    "example"
  ],
  "medList": [
    null
  ],
  "minBetCost": 0.5,
  "observerUsers": [
    "example"
  ],
  "orderId": "example",
  "orderType": "example",
  "pallets": 0,
  "possibleBetCount": 0,
  "possibleExecutorIds": [
    "example"
  ],
  "specialConditions": "example",
  "temperatureFrom": 0,
  "temperatureTo": 0,
  "toNp": null,
  "updateAt": null,
  "volume": 0.5,
  "weight": 0.5,
  "winnerExecuteId": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### DemandListForForwarderV0Response {#entity-DemandListForForwarderV0Response}

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

_items_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [DemandListForForwarderV0Demand](https://yamagistrali.ru/docs/ru-x-ai/methods/post-api-demand-listforforwarder-v0.md#entity-DemandListForForwarderV0Demand)[] &#124; null

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

```json translate=no
[
  {
    "agreementTerms": {
      "deferredPaymentDays": 0,
      "documentFormat": "example",
      "freeCancellationTime": 0,
      "idleHourCost": 0.5,
      "idleIncludedTariff": 0.5,
      "isFactoring": true,
      "isPrepayment": true,
      "paymentType": "example",
      "penaltyCancellation": 0.5,
      "penaltyForBeingLate": 0.5,
      "penaltyForProvidingDocuments": 0.5,
      "postponementDocumentSubmission": 0
    },
    "auction": {
      "cost": 0.5,
      "endDateTime": null,
      "exchange": "example",
      "isDowngradeOnly": true,
      "isInProgress": true,
      "isNoHigherMine": true,
      "startDateTime": null,
      "step": 0.5
    },
    "betCount": 0,
    "bodyType": [
      "example"
    ],
    "bodyTypeComment": "example",
    "canChooseWinner": true,
    "cargoType": "example",
    "cargoTypeComment": "example",
    "createAt": null,
    "creatorUser": "example",
    "declaredCost": 0.5,
    "demandStoreState": "example",
    "demandVirtualState": "example",
    "editorUsers": [
      "example"
    ],
    "extId": "example",
    "forwarderId": "example",
    "fromNp": {
      "address": "example",
      "comeTill": null,
      "comeWith": null,
      "comment": "example",
      "lat": 0.5,
      "loadingTime": 0,
      "locality": "example",
      "lon": 0.5,
      "nodalPointId": "example",
      "npLegalType": "example"
    },
    "id": "example",
    "isAutoAuction": true,
    "isUseMobileApp": true,
    "loadingType": [
      "example"
    ],
    "medList": [
      null
    ],
    "minBetCost": 0.5,
    "observerUsers": [
      "example"
    ],
    "orderId": "example",
    "orderType": "example",
    "pallets": 0,
    "possibleBetCount": 0,
    "possibleExecutorIds": [
      "example"
    ],
    "specialConditions": "example",
    "temperatureFrom": 0,
    "temperatureTo": 0,
    "toNp": null,
    "updateAt": null,
    "volume": 0.5,
    "weight": 0.5,
    "winnerExecuteId": "example"
  }
]
```

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

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

```json translate=no
{
  "items": [
    {
      "agreementTerms": {
        "deferredPaymentDays": 0,
        "documentFormat": "example",
        "freeCancellationTime": 0,
        "idleHourCost": 0.5,
        "idleIncludedTariff": 0.5,
        "isFactoring": true,
        "isPrepayment": true,
        "paymentType": "example",
        "penaltyCancellation": 0.5,
        "penaltyForBeingLate": 0.5,
        "penaltyForProvidingDocuments": 0.5,
        "postponementDocumentSubmission": 0
      },
      "auction": {
        "cost": 0.5,
        "endDateTime": null,
        "exchange": "example",
        "isDowngradeOnly": true,
        "isInProgress": true,
        "isNoHigherMine": true,
        "startDateTime": null,
        "step": 0.5
      },
      "betCount": 0,
      "bodyType": [
        "example"
      ],
      "bodyTypeComment": "example",
      "canChooseWinner": true,
      "cargoType": "example",
      "cargoTypeComment": "example",
      "createAt": {
        "displayTZ": "+03:00",
        "time": "2020-01-01T00:00:00"
      },
      "creatorUser": "example",
      "declaredCost": 0.5,
      "demandStoreState": "example",
      "demandVirtualState": "example",
      "editorUsers": [
        "example"
      ],
      "extId": "example",
      "forwarderId": "example",
      "fromNp": {
        "address": "example",
        "comeTill": null,
        "comeWith": null,
        "comment": "example",
        "lat": 0.5,
        "loadingTime": 0,
        "locality": "example",
        "lon": 0.5,
        "nodalPointId": "example",
        "npLegalType": "example"
      },
      "id": "example",
      "isAutoAuction": true,
      "isUseMobileApp": true,
      "loadingType": [
        "example"
      ],
      "medList": [
        null
      ],
      "minBetCost": 0.5,
      "observerUsers": [
        "example"
      ],
      "orderId": "example",
      "orderType": "example",
      "pallets": 0,
      "possibleBetCount": 0,
      "possibleExecutorIds": [
        "example"
      ],
      "specialConditions": "example",
      "temperatureFrom": 0,
      "temperatureTo": 0,
      "toNp": null,
      "updateAt": null,
      "volume": 0.5,
      "weight": 0.5,
      "winnerExecuteId": "example"
    }
  ]
}
```

{% 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/post-api-demand-listforforwarder-v0.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/post-api-demand-listforforwarder-v0.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/post-api-demand-listforforwarder-v0.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.