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

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

Получите организации с ролью заказчика, от имени которых можно создать заказ. Выберите организацию в `data.items` и передайте её `id` в `data.forwarder.forwarderId` при создании заказа.

> Блоки запроса и ответов ниже сгенерированы из 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/forwarder/allow
```

</div>

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

</div>

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "data": {
    "items": [
      {
        "country": "example",
        "defaultCurrency": "example",
        "dropPartnerFailOnCreateOrder": true,
        "id": "example",
        "legalAddress": "example",
        "legalType": "example",
        "name": "example",
        "orderDefaultIsNotVatPayer": true,
        "orderDefaultVat": 0.5,
        "phone": "example",
        "ruEdoEnabled": true,
        "tin": "example"
      }
    ]
  }
}
```

{% endcut %}

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

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

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

```json translate=no
{
  "items": [
    {
      "country": "example",
      "defaultCurrency": "example",
      "dropPartnerFailOnCreateOrder": true,
      "id": "example",
      "legalAddress": "example",
      "legalType": "example",
      "name": "example",
      "orderDefaultIsNotVatPayer": true,
      "orderDefaultVat": 0.5,
      "phone": "example",
      "ruEdoEnabled": true,
      "tin": "example"
    }
  ]
}
```

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

</div>

<div class="openapi-entity">

### OrderAllowedForwardersUserAllowRespItem {#entity-OrderAllowedForwardersUserAllowRespItem}

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

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

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

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

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

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

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

_dropPartnerFailOnCreateOrder_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: boolean &#124; null
{.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}
||
||

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

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

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

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

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

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

```json translate=no
{
  "country": "example",
  "defaultCurrency": "example",
  "dropPartnerFailOnCreateOrder": true,
  "id": "example",
  "legalAddress": "example",
  "legalType": "example",
  "name": "example",
  "orderDefaultIsNotVatPayer": true,
  "orderDefaultVat": 0.5,
  "phone": "example",
  "ruEdoEnabled": true,
  "tin": "example"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### OrderAllowedForwardersResponse {#entity-OrderAllowedForwardersResponse}

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

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

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

```json translate=no
[
  {
    "country": "example",
    "defaultCurrency": "example",
    "dropPartnerFailOnCreateOrder": true,
    "id": "example",
    "legalAddress": "example",
    "legalType": "example",
    "name": "example",
    "orderDefaultIsNotVatPayer": true,
    "orderDefaultVat": 0.5,
    "phone": "example",
    "ruEdoEnabled": true,
    "tin": "example"
  }
]
```

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

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

```json translate=no
{
  "items": [
    {
      "country": "example",
      "defaultCurrency": "example",
      "dropPartnerFailOnCreateOrder": true,
      "id": "example",
      "legalAddress": "example",
      "legalType": "example",
      "name": "example",
      "orderDefaultIsNotVatPayer": true,
      "orderDefaultVat": 0.5,
      "phone": "example",
      "ruEdoEnabled": true,
      "tin": "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/get-api-orders-v0-transferorder-forwarder-allow.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-forwarder-allow.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-forwarder-allow.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.