---
metadata:
  - name: generator
    content: Diplodoc Platform v5.15.5
alternate:
  - https://delivery.yango.com/docs/en/api/express/openapi/IntegrationV2Tariffs.md
---
> **Documentation Index:** Fetch the complete configuration index at https://delivery.yango.com/docs/en/llms.txt

<div class="openapi">

# Available rates

The response returns possible additional requirements in the supported_requirements field.
Available requirement values:
1) cargo_type, possible dimensions
2) cargo_loaders, possible loaders
3) cargo_options, possible additional options: driver courier - auto_courier, thermobag - thermobag
Each requirement has an options field that defines a list of possible values: you can select only one value for cargo_type/cargo_loaders and multiple values for cargo_options.
These requirements can be entered when creating a claim in the client_requirements.name field, where the name of the additional requirement is entered in the ''name'' field, where cargo_loaders, one of the options for cargo_type, is entered in the ''value'' field, or an options array for cargo_options.


## 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.delivery.yango.tech/b2b/cargo/integration/v2/tariffs
```



</div>

Service URL

</div>

</div>

### Headers

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

||
 Accept-Language<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Preferred response language. Examples: "en" — English<br>Example: `en` 
|||#{.openapi-table}

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "start_point": [
        0.1,
        0.1
    ],
    "fullname": "One Central Building 5, Trade Center Second, Dubai"
}
```


{% endcut %}


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

||
 fullname {.openapi-table-parameter-name} 
|
 **Type:** string

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:*{.openapi-description-annotation} `One Central Building 5, Trade Center Second, Dubai`
 
||

||
 start_point {.openapi-table-parameter-name} 
|
 **Type:** number[]

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

*Example:*{.openapi-description-annotation} 
```
[
  0.1,
  0.1
]
```

*Min items:*{.openapi-description-annotation} `2`

*Max items:*{.openapi-description-annotation} `2`
 
|||#{.openapi-table}

</div>

## Responses

<div class="openapi__response__code__200">

## 200 OK

OK

<div class="openapi-entity">

### Body

{% cut "application/json" %}


```json translate=no
{
    "available_tariffs": [
        {
            "name": "cargo",
            "title": "Express",
            "text": "Express rate",
            "minimal_price": 213,
            "supported_requirements": [
                {
                    "name": "cargo_type",
                    "title": "Body type",
                    "text": "Vehicle dimension requirement",
                    "type": "select",
                    "required": false,
                    "options": [
                        {
                            "title": "Small body",
                            "text": "170 cm long, 100 cm wide, 90 cm high",
                            "value": "van"
                        }
                    ]
                },
                {
                    "name": "string",
                    "title": "string",
                    "text": "string",
                    "type": "bool",
                    "default": false,
                    "required": false
                }
            ],
            "delivery_options": [
                {
                    "description": "string"
                }
            ]
        }
    ]
}
```


{% endcut %}


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

||
 available_tariffs<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** [B2BTariff](#b2btariff)[] 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### B2BTariff

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

||
 minimal_price<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** number

Minimum cost

*Example:*{.openapi-description-annotation} `213`
 
||

||
 name<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Rate

*Example:*{.openapi-description-annotation} `cargo`
 
||

||
 supported_requirements<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** ([SelectRequirement](#selectrequirement) 
or [BoolRequirement](#boolrequirement))[]

Supported delivery requirements<br> 
||

||
 text<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Rate description

*Example:*{.openapi-description-annotation} `Express rate`
 
||

||
 title<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Rate name

*Example:*{.openapi-description-annotation} `Express`
 
||

||
 delivery_options {.openapi-table-parameter-name} 
|
 **Type:** [DeliveryOption](#deliveryoption)[] 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### SelectRequirement

Requirement with a few options

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

||
 name<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Requirement type

*Example:*{.openapi-description-annotation} `cargo_type`
 
||

||
 options<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** [CargoRequirementChoice](#cargorequirementchoice)[]

Possible selection options<br>

*Min items:*{.openapi-description-annotation} `1`
 
||

||
 required<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** boolean

Mandatory requirement for creating an order

*Example:*{.openapi-description-annotation} `false`
 
||

||
 text<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Localized description of the requirement type

*Example:*{.openapi-description-annotation} `Vehicle dimension requirement`
 
||

||
 title<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Localized requirement name

*Example:*{.openapi-description-annotation} `Body type`
 
||

||
 type<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** [SelectType](#selecttype)

Selection type: single or multiple

*Example:*{.openapi-description-annotation} `select`

*Enum:*{.openapi-description-annotation} `select`, `multi_select`
 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### BoolRequirement

"Yes/no" requirement format

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

||
 default<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** boolean

Default value 
||

||
 name<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Requirement type 
||

||
 required<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** boolean

You must select a field 
||

||
 text<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Localized description of the requirement type 
||

||
 title<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Localized name of the requirement type 
||

||
 type<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Selection type: yes or no

*Enum:*{.openapi-description-annotation} `bool`
 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### DeliveryOption

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

||
 description<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Localized description 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### CargoRequirementChoice

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

||
 text<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Localized requirement description

*Example:*{.openapi-description-annotation} `170 cm long, 100 cm wide, 90 cm high`
 
||

||
 title<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Localized requirement name

*Example:*{.openapi-description-annotation} `Small body`
 
||

||
 value<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string 
or integer

The value that needs to be entered to take into account the requirement when creating an order

*Example:*{.openapi-description-annotation} `van`
 
|||#{.openapi-table}

</div>

<div class="openapi-entity">

### SelectType

Selection type: single or multiple

#|||
 **Type** 
|
 **Description** 
||

||
 [SelectType](#selecttype) 
|
 

*Example:*{.openapi-description-annotation} `select`

*Enum:*{.openapi-description-annotation} `select`, `multi_select`
 
|||#{.openapi-table}

</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<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error code

*Example:*{.openapi-description-annotation} `bad_request`

*Enum:*{.openapi-description-annotation} `bad_request`, `address_not_found`
 
||

||
 message<span class="openapi__required">*</span> {.openapi-table-parameter-name} 
|
 **Type:** string

Error description

*Example:*{.openapi-description-annotation} `bad request`
 
|||#{.openapi-table}

</div>

</div>
<!-- markdownlint-disable-file -->

</div>



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