Доставка в течение дня

Метод возвращает список услуг, доступных в точке, с учетом их опций.
Ответ состоит из двух объектов:

  1. express_delivery — содержит доступные тарифы и опции для Экспресс-доставки;
  2. same_day_delivery — содержит доступные интервалы для доставки В течение дня. Недоступно в России.
    Каждый из объектов содержит поле allowed, которое обозначает, доступна ли эта опция для указанного тарифа.

Request

POST

b2b.taxi.yandex.net/b2b/cargo/integration/v2/delivery-methods

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

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

OK

Body

application/json
{
  "express_delivery": {
    "allowed": true,
    "available_tariffs": [
      {
        "name": "cargo",
        "title": "Экспресс",
        "text": "Тариф экспресс",
        "minimal_price": 213,
        "supported_requirements": [
          null
        ],
        "delivery_options": [
          {}
        ]
      }
    ]
  },
  "same_day_delivery": {
    "allowed": true,
    "available_intervals": [
      {
        "from": "2020-01-01T00:00:00+00:00",
        "to": "2020-01-02T00:00:00+00:00"
      }
    ]
  }
}

Name

Description

express_delivery

Type: ExpressDeliveryInfo

Информация о доступных тарифах "Экспресс-доставки"

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

same_day_delivery

Type: SameDayDeliveryInfo

Информация о доступных интервалах доставки "В течение дня"

Example
{
  "allowed": true,
  "available_intervals": [
    {
      "from": "2020-01-01T00:00:00+00:00",
      "to": "2020-01-02T00:00:00+00:00"
    }
  ]
}

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

ExpressDeliveryInfo

Информация о доступных тарифах "Экспресс-доставки"

Name

Description

allowed

Type: boolean

"Экспресс-доставка" доступна

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"
      }
    ]
  }
]
Example
{
  "allowed": true,
  "available_tariffs": [
    {
      "name": "cargo",
      "title": "Экспресс",
      "text": "Тариф экспресс",
      "minimal_price": 213,
      "supported_requirements": [
        {}
      ],
      "delivery_options": [
        {
          "description": "example"
        }
      ]
    }
  ]
}

TimeInterval

Временной интервал

Name

Description

from

Type: string<date-time>

Начало интервала

Example: 2020-01-01T00:00:00+00:00

to

Type: string<date-time>

Окончание интервала (дата и время)

Example: 2020-01-02T00:00:00+00:00
Example
{
  "from": "2020-01-01T00:00:00+00:00",
  "to": "2020-01-02T00:00:00+00:00"
}

SameDayDeliveryInfo

Информация о доступных интервалах доставки "В течение дня"

Name

Description

allowed

Type: boolean

Доставка "В течение дня" доступна

available_intervals

Type: TimeInterval[]

Доступные интервалы доставки "В течение дня"

Example
[
  {
    "from": "2020-01-01T00:00:00+00:00",
    "to": "2020-01-02T00:00:00+00:00"
  }
]
Example
{
  "allowed": true,
  "available_intervals": [
    {
      "from": "2020-01-01T00:00:00+00:00",
      "to": "2020-01-02T00:00:00+00:00"
    }
  ]
}

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

No longer supported, please use an alternative and newer version.

Предыдущая
6.3 Журнал изменений
Следующая
8. Готовность заказа к выдаче