Available rates

The response returns possible additional requirements in the supported_requirements field.
Available requirement values:

cargo_type, possible dimensions
cargo_loaders, possible loaders
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

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/tariffs

Service URL

Headers

Name

Description

Accept-Language*

Type: string

Preferred response language. Examples: "en" — English

Example: en

Body

application/json

{
    "start_point": [
        0.1,
        0.1
    ],
    "fullname": "One Central Building 5, Trade Center Second, Dubai"
}

Name

Description

fullname

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: One Central Building 5, Trade Center Second, Dubai

start_point

Type: number[]

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

Example: 0.1,0.1

Max items: 2

Min items: 2

Responses

200 OK

Body

application/json

{
    "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"
                }
            ]
        }
    ]
}

Name	Description
available_tariffs*	Type: B2BTariff[]

B2BTariff

Name	Description
minimal_price*	Type: number Minimum cost Example: `213`
name*	Type: string Rate Example: `cargo`
supported_requirements*	Type: (SelectRequirement or BoolRequirement)[] Supported delivery requirements
text*	Type: string Rate description Example: `Express rate`
title*	Type: string Rate name Example: `Express`
delivery_options	Type: DeliveryOption[]

SelectRequirement

Requirement with a few options

Name	Description
name*	Type: string Requirement type Example: `cargo_type`
options*	Type: CargoRequirementChoice[] Possible selection options Min items: `1`
required*	Type: boolean Mandatory requirement for creating an order
text*	Type: string Localized description of the requirement type Example: `Vehicle dimension requirement`
title*	Type: string Localized requirement name Example: `Body type`
type*	Type: SelectType Selection type: single or multiple Example: `select` Enum: `select`, `multi_select`

BoolRequirement

"Yes/no" requirement format

Name	Description
default*	Type: boolean Default value
name*	Type: string Requirement type
required*	Type: boolean You must select a field
text*	Type: string Localized description of the requirement type
title*	Type: string Localized name of the requirement type
type*	Type: string Selection type: yes or no Enum: `bool`

DeliveryOption

Name

Description

description*

Type: string

Localized description

CargoRequirementChoice

Name	Description
text*	Type: string Localized requirement description Example: `170 cm long, 100 cm wide, 90 cm high`
title*	Type: string Localized requirement name Example: `Small body`
value*	Type: string or integer The value that needs to be entered to take into account the requirement when creating an order Example: `van`

SelectType

Selection type: single or multiple

Type

Description

SelectType

Example: select

Enum: select, multi_select

400 Bad Request

Invalid request

Body

application/json

{
    "code": "bad_request",
    "message": "bad request"
}

Name

Description

code*

Type: string

Error code

Example: bad_request

Enum: bad_request, address_not_found

message*

Type: string

Error description

Example: bad request

Available rates

Request

Headers

Body

Responses

200 OK

Body

B2BTariff

SelectRequirement

BoolRequirement

DeliveryOption

CargoRequirementChoice

SelectType

400 Bad Request

Body

Was the article helpful?