---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.ru/support/delivery-profile/en/api/express/openapi/IntegrationV2CheckPrice.md
  - https://yandex.ru/support/delivery-profile/ru/api/express/openapi/IntegrationV2CheckPrice.md
  - href: en/api/express/openapi/IntegrationV2CheckPrice.md
    type: text/markdown
    title: Markdown version
  - href: ../../../llms.txt
    type: text/markdown
    title: llms.txt
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/support/delivery-profile/en/llms.txt

<div class="openapi">

# Preliminary evaluation without creating a claim

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

## 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
b2b.taxi.yandex.net/b2b/cargo/integration/v2/check-price
```

</div>

Service URL

</div>

</div>

### Headers

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

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

Preferred response language. Examples: "en" — English

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

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "items": [
    {
      "size": {
        "length": 0.1,
        "width": 0.2,
        "height": 0.3
      },
      "weight": 2.105,
      "quantity": 1,
      "pickup_point": 1,
      "dropoff_point": 2
    }
  ],
  "route_points": [
    {
      "id": 1,
      "coordinates": [
        0.1,
        0.1
      ],
      "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A"
    }
  ],
  "requirements": {
    "taxi_class": "cargo",
    "cargo_type": "lcv_m",
    "cargo_loaders": 1,
    "pro_courier": false,
    "cargo_options": [
      "thermobag"
    ],
    "same_day_data": {
      "delivery_interval": {
        "from": "2020-01-01T00:00:00+00:00",
        "to": "2020-01-02T00:00:00+00:00"
      }
    }
  },
  "skip_door_to_door": false
}
```

{% endcut %}

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

_route_points_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [RoutePointWithAddress](#entity-RoutePointWithAddress)[]

Route points. Sorted in order of visits A-B1....BN

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

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

```json translate=no
[
  {
    "id": 1,
    "coordinates": [
      0.1,
      0.1
    ],
    "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A"
  }
]
```

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

_items_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Item](#entity-Item)[]

Item parameters

_Min items:_{.json-schema-reset .json-schema-assertion} `1`

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

```json translate=no
[
  {
    "size": {
      "length": 0.1,
      "width": 0.2,
      "height": 0.3
    },
    "weight": 2.105,
    "quantity": 1,
    "pickup_point": 1,
    "dropoff_point": 2
  }
]
```

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

_requirements_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Requirements](#entity-Requirements)

Delivery requirements (vehicle class, options)

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

```json translate=no
{
  "taxi_class": "cargo",
  "cargo_type": "lcv_m",
  "cargo_loaders": 1,
  "pro_courier": false,
  "cargo_options": [
    "thermobag"
  ],
  "same_day_data": {
    "delivery_interval": {
      "from": "2020-01-01T00:00:00+00:00",
      "to": "2020-01-02T00:00:00+00:00"
    }
  }
}
```

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

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

Disable door-to-door delivery (disable the "Door-to-door" option).
Possible values:
- true (the courier will deliver the order only at the entrance outside)
- false (the courier will deliver the order at the door) - default value.


_Default:_{.json-schema-reset .json-schema-value} `false`
{.table-cell}
||
|#{.json-schema-properties}

</div>

<div class="openapi-entity">

### CargoItemSizes {#entity-CargoItemSizes}

Unit dimensions in meters. The actual values should be added to the fields.
If the dimensions aren't added, the order is placed, taking into account the maximum dimensions allowed for the selected rate.
If the actual characteristics of the unit exceed the allowed dimensions, the courier has the right to refuse to fulfill the order on site.
In this case, the minimum fee will be withheld.
Courier: up to 0.80 m × 0.50 m × 0.50 м
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:
- Small body: up to 1.70 m × 0.96 m × 0.90 m
- Medium body: up to 2.60 m × 1.30 m × 1.50 m
- Large body: up to 3.80 m × 1.80 m × 1.80 m


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

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

Height in meters
{.table-cell}
||
||

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

Length in meters
{.table-cell}
||
||

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

Width in meters
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "length": 0.1,
  "width": 0.2,
  "height": 0.3
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Item {#entity-Item}

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

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

Number of items

_Min value:_{.json-schema-reset .json-schema-assertion} `1`
{.table-cell}
||
||

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

ID of the point (int64) to deliver the item to.
It can be any number. Must match the route_points[].id value of the destination point.
The parameter is mandatory if there are multiple delivery points in the order.

{.table-cell}
||
||

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

ID of the point (int64) to pick up the item from.
It can be any number. Must match the route_points[].id value of the dispatch point.
The parameter is mandatory if there are multiple delivery points in the order.

{.table-cell}
||
||

_size_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [CargoItemSizes](#entity-CargoItemSizes)

Unit dimensions in meters. The actual values should be added to the fields.
If the dimensions aren't added, the order is placed, taking into account the maximum dimensions allowed for the selected rate.
If the actual characteristics of the unit exceed the allowed dimensions, the courier has the right to refuse to fulfill the order on site.
In this case, the minimum fee will be withheld.
Courier: up to 0.80 m × 0.50 m × 0.50 м
Express: up to 1.00 m × 0.60 m × 0.50 m
Cargo:
- Small body: up to 1.70 m × 0.96 m × 0.90 m
- Medium body: up to 2.60 m × 1.30 m × 1.50 m
- Large body: up to 3.80 m × 1.80 m × 1.80 m


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

```json translate=no
{
  "length": 0.1,
  "width": 0.2,
  "height": 0.3
}
```

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

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

Item weight in kilograms.
Example: 2.105

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

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

```json translate=no
{
  "size": {
    "length": 0.1,
    "width": 0.2,
    "height": 0.3
  },
  "weight": 2.105,
  "quantity": 1,
  "pickup_point": 1,
  "dropoff_point": 2
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Point {#entity-Point}

Coordinates of points in the form of an array of two real numbers: longitude and latitude — exactly in that order.

**Type**: number[]

_Min items:_{.json-schema-reset .json-schema-assertion} `2`

_Max items:_{.json-schema-reset .json-schema-assertion} `2`

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

```json translate=no
[
  0.1,
  0.1
]
```

{% endcut %}

</div>

<div class="openapi-entity">

### AddressFullname {#entity-AddressFullname}

Full address with an indication of the city, street, and house number.
You don't need to specify the flat, the entrance number, or the floor. 


**Type**: string

_Example:_{.json-schema-reset .json-schema-example} `Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A`

</div>

<div class="openapi-entity">

### RoutePointWithAddress {#entity-RoutePointWithAddress}

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

_coordinates_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [Point](#entity-Point)

Coordinates of points in the form of an array of two real numbers: longitude and latitude — exactly in that order.

_Min items:_{.json-schema-reset .json-schema-assertion} `2`

_Max items:_{.json-schema-reset .json-schema-assertion} `2`

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

```json translate=no
[
  0.1,
  0.1
]
```

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

_fullname_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [AddressFullname](#entity-AddressFullname)

Full address with an indication of the city, street, and house number.
You don't need to specify the flat, the entrance number, or the floor. 


_Example:_{.json-schema-reset .json-schema-example} `Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A`
{.table-cell}
||
||

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

Numeric point id (int64). The parameter is mandatory if there are multiple delivery points in the order
{.table-cell}
||
|#{.json-schema-properties}

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

```json translate=no
{
  "id": 1,
  "coordinates": [
    0.1,
    0.1
  ],
  "fullname": "Saint Petersburg, Bol'shaya Monetnaya Street, 1f1A"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### CargoType {#entity-CargoType}

 Body type (size) for the cargo rate.\nPossible values:
- van (\"Small body\")
- lcv_m (\"Medium body\")
- lcv_l (\"Large body\")
- lcv_xl ("XL body")
For an exact list of possible values for a particular geo point,\nuse the method for obtaining rates [tariffs](https://yandex.ru/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md)


**Type**: string

_Enum:_{.json-schema-reset .json-schema-value} `van`, `lcv_m`, `lcv_l`, `lcv_xl`

</div>

<div class="openapi-entity">

### CargoOptions {#entity-CargoOptions}

List of additional rate options.

Possible separate options:
  - auto_courier (a courier with a vehicle only)
  - thermobag (a courier with a thermobag)
        
Example of a list of options: ["auto_courier"].

For an exact list of possible values for a particular geo point,
use the method for obtaining rates [tariffs](https://yandex.ru/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md)


**Type**: string[]

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

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

{% endcut %}

</div>

<div class="openapi-entity">

### TimeInterval {#entity-TimeInterval}

Time interval

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

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

Interval start

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

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

Interval end (date and time)

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

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

```json translate=no
{
  "from": "2020-01-01T00:00:00+00:00",
  "to": "2020-01-02T00:00:00+00:00"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### Requirements {#entity-Requirements}

Delivery requirements (vehicle class, options)

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

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

Number of loaders for the cargo rate.
Possible values: 0, 1, 2.
For an exact list of possible values for a particular geo point, use the method for obtaining rates [tariffs](https://yandex.ru/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md)

{.table-cell}
||
||

_cargo_options_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [CargoOptions](#entity-CargoOptions)

List of additional rate options.

Possible separate options:
  - auto_courier (a courier with a vehicle only)
  - thermobag (a courier with a thermobag)
        
Example of a list of options: ["auto_courier"].

For an exact list of possible values for a particular geo point,
use the method for obtaining rates [tariffs](https://yandex.ru/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md)


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

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

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

_cargo_type_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [CargoType](#entity-CargoType)

 Body type (size) for the cargo rate.\nPossible values:
- van (\"Small body\")
- lcv_m (\"Medium body\")
- lcv_l (\"Large body\")
- lcv_xl ("XL body")
For an exact list of possible values for a particular geo point,\nuse the method for obtaining rates [tariffs](https://yandex.ru/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md)


_Enum:_{.json-schema-reset .json-schema-value} `van`, `lcv_m`, `lcv_l`, `lcv_xl`
{.table-cell}
||
||

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

Enable the "Pro" option for "Express" and "Courier" rates.
In this case, we will look only for experienced couriers.

{.table-cell}
||
||

_same_day_data_{.json-schema-reset .json-schema-property}
{.table-cell}|
{% cut "**Type**: object" %}

#|
||

_delivery_interval_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [TimeInterval](#entity-TimeInterval)

Time interval

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

```json translate=no
{
  "from": "2020-01-01T00:00:00+00:00",
  "to": "2020-01-02T00:00:00+00:00"
}
```

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

{% endcut %}

"Same-day delivery" options

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

```json translate=no
{
  "delivery_interval": {
    "from": "2020-01-01T00:00:00+00:00",
    "to": "2020-01-02T00:00:00+00:00"
  }
}
```

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

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

Delivery vehicle class.
Possible values: courier, express, cargo.
For an exact list of possible values for a particular geo point, use the method for obtaining rates [tariffs](https://yandex.ru/support/delivery-profile/en/api/express/openapi/IntegrationV2Tariffs.md)


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

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

```json translate=no
{
  "taxi_class": "cargo",
  "cargo_type": "lcv_m",
  "cargo_loaders": 1,
  "pro_courier": false,
  "cargo_options": [
    "thermobag"
  ],
  "same_day_data": {
    "delivery_interval": {
      "from": "2020-01-01T00:00:00+00:00",
      "to": "2020-01-02T00:00:00+00:00"
    }
  }
}
```

{% endcut %}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "price": "12.50",
  "currency_rules": {
    "code": "RUB",
    "text": "rub.",
    "template": "$VALUE$ $SIGN$$CURRENCY$",
    "sign": "₽"
  },
  "requirements": {
    "taxi_class": "cargo",
    "cargo_type": "lcv_m",
    "cargo_loaders": 1,
    "pro_courier": false,
    "cargo_options": [
      "thermobag"
    ],
    "same_day_data": {
      "delivery_interval": {
        "from": "2020-01-01T00:00:00+00:00",
        "to": "2020-01-02T00:00:00+00:00"
      }
    }
  },
  "distance_meters": 10,
  "eta": 10,
  "zone_id": "moscow"
}
```

{% endcut %}

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

_price_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [Money](#entity-Money)

Delivery cost in Decimal(18, 4) format

_Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$`

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

_requirements_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [Requirements](#entity-Requirements)

Delivery requirements (vehicle class, options)

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

```json translate=no
{
  "taxi_class": "cargo",
  "cargo_type": "lcv_m",
  "cargo_loaders": 1,
  "pro_courier": false,
  "cargo_options": [
    "thermobag"
  ],
  "same_day_data": {
    "delivery_interval": {
      "from": "2020-01-01T00:00:00+00:00",
      "to": "2020-01-02T00:00:00+00:00"
    }
  }
}
```

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

_currency_rules_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [CurrencyRules](#entity-CurrencyRules)

Currency display rules

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

```json translate=no
{
  "code": "RUB",
  "text": "rub.",
  "template": "$VALUE$ $SIGN$$CURRENCY$",
  "sign": "₽"
}
```

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

_distance_meters_{.json-schema-reset .json-schema-property}
{.table-cell}|
**Type**: [RouteDistance](#entity-RouteDistance)

Distance in meters for the specified route, from the first to the last point

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

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

Estimated time of arrival in minutes
{.table-cell}
||
||

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

Delivery zone ID

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

</div>

<div class="openapi-entity">

### Money {#entity-Money}

Delivery cost in Decimal(18, 4) format

**Type**: string

_Pattern:_{.json-schema-reset .json-schema-assertion} `^-?[0-9]{1,14}(\.[0-9]{0,4})?$`

_Example:_{.json-schema-reset .json-schema-example} `12.50`

</div>

<div class="openapi-entity">

### Currency {#entity-Currency}

Three-digit code of the payment currency

**Type**: string

_Min length:_{.json-schema-reset .json-schema-assertion} `3`

_Max length:_{.json-schema-reset .json-schema-assertion} `3`

_Example:_{.json-schema-reset .json-schema-example} `RUB`

</div>

<div class="openapi-entity">

### CurrencyRules {#entity-CurrencyRules}

Currency display rules

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

_code_{.json-schema-reset .json-schema-property .json-schema-required}
{.table-cell}|
**Type**: [Currency](#entity-Currency)

Three-digit code of the payment currency

_Min length:_{.json-schema-reset .json-schema-assertion} `3`

_Max length:_{.json-schema-reset .json-schema-assertion} `3`

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

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

Currency display template

_Example:_{.json-schema-reset .json-schema-example} `$VALUE$ $SIGN$$CURRENCY$`
{.table-cell}
||
||

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

Short currency name

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

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

Currency symbol

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

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

```json translate=no
{
  "code": "RUB",
  "text": "rub.",
  "template": "$VALUE$ $SIGN$$CURRENCY$",
  "sign": "₽"
}
```

{% endcut %}

</div>

<div class="openapi-entity">

### RouteDistance {#entity-RouteDistance}

Distance in meters for the specified route, from the first to the last point

**Type**: number

</div>

</div>

<div class="openapi__response__code__400">

## 400 Bad Request

Invalid request

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "bad_request",
  "message": "bad request"
}
```

{% endcut %}

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

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

Error code

_Enum:_{.json-schema-reset .json-schema-value} `bad_request`, `address_not_found`
{.table-cell}
||
||

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

Error description

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

</div>

</div>

<div class="openapi__response__code__409">

## 409 Conflict

No suitable vehicles | Couldn't build the route

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "estimating.requirement_unavailable",
  "message": "requirement unavailable"
}
```

{% endcut %}

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

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

Error code

_Enum:_{.json-schema-reset .json-schema-value} `errors.suitable_offer_not_found`, `estimating.cant_construct_route`, `estimating.cargocorp_payment_failure`, `estimating.claim.no_zone_id`, `estimating.limited_by_claims_creation_overflow`, `estimating.no_pickup_point`, `estimating.payment_method_cant_order`, `estimating.payment_method_zone_unavailable`, `estimating.permitted_tariffs_not_enough`, `estimating.requirement_unavailable`, `estimating.route_too_long`, `estimating.tariff.no_categories`, `estimating.tariff.no_categories_in_zone`, `estimating.tariff.no_sdd_tariff`, `estimating.tariff.no_tariff_plan`, `estimating.too_large_linear_size`, `estimating.too_many_loaders`, `estimating.warning.too_heavy_item`, `estimating.warning.too_large_item`
{.table-cell}
||
||

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

Error description

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

</div>

</div>

<div class="openapi__response__code__429">

## 429 Too Many Requests

Too many requests

<div class="openapi-entity">

### Body

{% cut "application/json" %}

```json translate=no
{
  "code": "too_many_requests",
  "message": "Too many requests"
}
```

{% endcut %}

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

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

Error code

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

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

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

Error description

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

</div>

</div>

</div>

[*Deprecated]: No longer supported, please use an alternative and newer version.