Доступные тарифы

В ответе в поле supported_requirements возвращаются возможные дополнительные требования.
Доступные значения требований:
1)cargo_type, возможные варианты габаритов
2)cargo_loaders возможные варианты грузчиков
3)cargo_options возможные дополнительные опции: автокурьер - auto_courier, термосумка - thermobag
У каждого требования есть поле options, в котором определен список возможных значений,
для cargo_type/cargo_loaders можно выбрать только одно значение,
для cargo_options — несколько значений.
Данные требования можно передавать при создании заявки в поле client_requirements.name,
где в name передается имя дополнительного требования,
в value передается один из вариантов для cargo_type, cargo_loaders
или массив вариантов для cargo_options.

Request

POST

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

Адрес сервиса

Headers

Name

Description

Accept-Language*

Type: string

Предпочитаемый язык ответа

Например:
ru — русский
en — английский

Example: ru

Body

application/json
{
    "start_point": [
        0.1,
        0.1
    ],
    "fullname": "Санкт-Петербург, Большая Монетная улица, 1к1А"
}

Name

Description

fullname

Type: string

Полный адрес с указанием города, улицы и номера дома.
Номер квартиры, подъезда и этаж указывать не нужно.

Example: Санкт-Петербург, Большая Монетная улица, 1к1А

start_point

Type: number[]

Координаты точек в виде массива из двух вещественных чисел: долгота, широта — именно в таком порядке.

Example: 0.1,0.1

Min items: 2

Max items: 2

Responses

200 OK

OK

Body

application/json
{
    "available_tariffs": [
        {
            "name": "cargo",
            "title": "Экспресс",
            "text": "Тариф экспресс",
            "minimal_price": 213,
            "supported_requirements": [
                {
                    "name": "cargo_type",
                    "title": "Тип кузова",
                    "text": "Требование габаритов транспортного средства",
                    "type": "select",
                    "required": false,
                    "options": [
                        {
                            "title": "Маленький кузов",
                            "text": "170 см в длину, 100 в ширину, 90 в высоту",
                            "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

Минимальная стоимость

Example: 213

name*

Type: string

Тариф

Example: cargo

supported_requirements*

Type: (SelectRequirement
or BoolRequirement)[]

Поддерживаемые требования к доставке

text*

Type: string

Описание тарифа

Example: Тариф экспресс

title*

Type: string

Название тарифа

Example: Экспресс

delivery_options

Type: DeliveryOption[]

SelectRequirement

Требование с выбором из нескольких вариантов

Name

Description

name*

Type: string

Тип требования

Example: cargo_type

options*

Type: CargoRequirementChoice[]

Возможные варианты выбора

Min items: 1

required*

Type: boolean

Требование обязательно для создания заказа

Example: false

text*

Type: string

Локализованное описание типа требования

Example: Требование габаритов транспортного средства

title*

Type: string

Локализованное название требования

Example: Тип кузова

type*

Type: SelectType

Тип выбора: одиночный или множественный

Example: select

Enum: select, multi_select

BoolRequirement

Требование формата "да/нет"

Name

Description

default*

Type: boolean

Значение по умолчанию

name*

Type: string

Тип требования

required*

Type: boolean

Поле обязательно выбрать

text*

Type: string

Локализованое описание типа требования

title*

Type: string

Локализованое название типа требования

type*

Type: string

Тип выбора: да или нет

Enum: bool

DeliveryOption

Name

Description

description*

Type: string

Локализованное описание

CargoRequirementChoice

Name

Description

text*

Type: string

Локализованое описание требования

Example: 170 см в длину, 100 в ширину, 90 в высоту

title*

Type: string

Локализованное название требования

Example: Маленький кузов

value*

Type: string
or integer

Значение, которое необходимо передать для учета требования при создании заказа

Example: van

SelectType

Тип выбора: одиночный или множественный

Type

Description

SelectType

Example: select

Enum: select, multi_select

400 Bad Request

Неверный запрос

Body

application/json
{
    "code": "bad_request",
    "message": "bad request"
}

Name

Description

code*

Type: string

Код ошибки

Example: bad_request

Enum: unknown_error, bad_request, address_not_found

message*

Type: string

Описание ошибки

Example: bad request
Предыдущая
6. Отмена заявки
Следующая
1.2 Первичная оценка