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

В ответе в поле 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: AddressFullname

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

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

start_point

Type: Point

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

Min items: 2

Max items: 2

Example

[
  0.1,
  0.1
]

Point

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

Type: number[]

Min items: 2

Max items: 2

Example

[
  0.1,
  0.1
]

AddressFullname

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

Type: string

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

Responses

200 OK

Body

application/json

{
  "available_tariffs": [
    {
      "name": "cargo",
      "title": "Экспресс",
      "text": "Тариф экспресс",
      "minimal_price": 213,
      "supported_requirements": [
        {}
      ],
      "delivery_options": [
        {
          "description": "example"
        }
      ]
    }
  ]
}

Name

Description

available_tariffs

Type: B2BTariff[]

Example

[
  {
    "name": "cargo",
    "title": "Экспресс",
    "text": "Тариф экспресс",
    "minimal_price": 213,
    "supported_requirements": [
      {
        "name": "cargo_type",
        "title": "Тип кузова",
        "text": "Требование габаритов транспортного средства",
        "type": "select",
        "required": false,
        "options": [
          null
        ]
      }
    ],
    "delivery_options": [
      {
        "description": "example"
      }
    ]
  }
]

Tariff

Тариф

Type: string

Example: cargo

SelectType

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

Type: string

Enum: select, multi_select

CargoRequirementChoice

Name	Description
text	Type: string Локализованое описание требования Example: `170 см в длину, 100 в ширину, 90 в высоту`
title	Type: string Локализованное название требования Example: `Маленький кузов`
value	One of 2 types Type: string Example: `example` Type: integer Значение, которое необходимо передать для учета требования при создании заказа Example: `van`

Example

{
  "title": "Маленький кузов",
  "text": "170 см в длину, 100 в ширину, 90 в высоту",
  "value": "van"
}

SelectRequirement

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

Name	Description
name	Type: string Тип требования Example: `cargo_type`
options	Type: CargoRequirementChoice[] Возможные варианты выбора Min items: `1` Example `[ { "title": "Маленький кузов", "text": "170 см в длину, 100 в ширину, 90 в высоту", "value": "van" } ]`
required	Type: boolean Требование обязательно для создания заказа
text	Type: string Локализованное описание типа требования Example: `Требование габаритов транспортного средства`
title	Type: string Локализованное название требования Example: `Тип кузова`
type	Type: SelectType Тип выбора: одиночный или множественный Enum: `select`, `multi_select`

Example

{
  "name": "cargo_type",
  "title": "Тип кузова",
  "text": "Требование габаритов транспортного средства",
  "type": "select",
  "required": false,
  "options": [
    {
      "title": "Маленький кузов",
      "text": "170 см в длину, 100 в ширину, 90 в высоту",
      "value": "van"
    }
  ]
}

BoolRequirement

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

Name	Description
default	Type: boolean Значение по умолчанию
name	Type: string Тип требования Example: `example`
required	Type: boolean Поле обязательно выбрать
text	Type: string Локализованое описание типа требования Example: `example`
title	Type: string Локализованое название типа требования Example: `example`
type	Type: string Тип выбора: да или нет Const: `bool` Example: `example`

Example

{
  "name": "example",
  "title": "example",
  "text": "example",
  "type": "bool",
  "default": true,
  "required": true
}

TariffRequirement

One of 2 types

Type: SelectRequirement

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

Example

{
  "name": "cargo_type",
  "title": "Тип кузова",
  "text": "Требование габаритов транспортного средства",
  "type": "select",
  "required": false,
  "options": [
    {
      "title": "Маленький кузов",
      "text": "170 см в длину, 100 в ширину, 90 в высоту",
      "value": "van"
    }
  ]
}

Type: BoolRequirement

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

Example

{
  "name": "example",
  "title": "example",
  "text": "example",
  "type": "bool",
  "default": true,
  "required": true
}

Example

{
  "name": "cargo_type",
  "title": "Тип кузова",
  "text": "Требование габаритов транспортного средства",
  "type": "select",
  "required": false,
  "options": [
    {
      "title": "Маленький кузов",
      "text": "170 см в длину, 100 в ширину, 90 в высоту",
      "value": "van"
    }
  ]
}

DeliveryOption

Name

Description

description

Type: string

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

Example: example

Example

{
  "description": "example"
}

B2BTariff

Name	Description
minimal_price	Type: number Минимальная стоимость
name	Type: Tariff Тариф Example: `cargo`
supported_requirements	Type: TariffRequirement[] Поддерживаемые требования к доставке Example `[ { "name": "cargo_type", "title": "Тип кузова", "text": "Требование габаритов транспортного средства", "type": "select", "required": false, "options": [ { "title": "Маленький кузов", "text": "170 см в длину, 100 в ширину, 90 в высоту", "value": "van" } ] } ]`
text	Type: string Описание тарифа Example: `Тариф экспресс`
title	Type: string Название тарифа Example: `Экспресс`
delivery_options	Type: DeliveryOption[] Example `[ { "description": "example" } ]`

Example

{
  "name": "cargo",
  "title": "Экспресс",
  "text": "Тариф экспресс",
  "minimal_price": 213,
  "supported_requirements": [
    {
      "name": "cargo_type",
      "title": "Тип кузова",
      "text": "Требование габаритов транспортного средства",
      "type": "select",
      "required": false,
      "options": [
        {}
      ]
    }
  ],
  "delivery_options": [
    {
      "description": "example"
    }
  ]
}

400 Bad Request

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

Body

application/json

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

Name

Description

code

Type: string

Код ошибки

Enum: unknown_error, bad_request, address_not_found

message

Type: string

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

Example: bad request

Была ли статья полезна?

6. Отмена заявки

1.2 Первичная оценка