Начало работы

API Яндекс Доставки предоставляет бизнесу возможность использовать HTTP-запросы для создания заказа.

Доступ к API

Перед началом работы с API получите токен:

1. Войдите в личный кабинет. Для входа используйте логин и пароль, полученные от менеджера Яндекс Доставки.

2. Перейдите на вкладку Интеграции.

3. В разделе Активируйте интеграцию нажмите Получить токен.

4. Используйте этот токен для взаимодействия с API Яндекс Доставки. Для этого в каждом запросе передавайте токен в заголовке Authorization:

Authorization: Bearer <OAuth-токен>

OAuth-токен действует неограниченное время.

Способы доставки и алгоритм заказа

В России

Для заказов на территории России доступны:

  • Экспресс-доставка:

    • с вызовом курьера на ближайшее время. Варианты доставки могут отличаться в зависимости от сроков прибытия курьера.

    • с отложенным заказом (если необходимо указать желаемое время прибытия курьера к отправителю).

  • Грузовая доставка:

    • с вызовом курьера на ближайшее время;

    • с отложенным заказом.

Все запросы к API Яндекс Доставки выполняются к хосту https://b2b.taxi.yandex.net.

Этапы заказа

Описание

Метод API

1. Получите варианты доставки.

Вы отправляете запрос, система рассчитывает предварительную стоимость доступных вариантов доставки.

offers/calculate

2. Создайте заявку на доставку.

Вы создаете заявку на выбранный вариант доставки по конкретному адресу.

claims/create

3. Узнайте результат оценки заказа.

Вы отправляете запрос. Если заявка может быть выполнена, в ответ придет актуальная стоимость заказа.
Если нет — в ответе будут причины, по которым заявка не может быть выполнена.

claims/info

4. Подтвердите заявку.

Если вы согласны с условиями доставки, вы подтверждаете заявку. После этого запускается поиск исполнителя.

claims/accept

5. Отслеживайте статусы заявки.

Вы отправляете запрос по одной или нескольким заявкам и получаете по ним информацию.

Подробнее читайте в разделе Методы API:

В случае проблем обратитесь к менеджеру Яндекс Доставки.

В других странах

Для заказов на территории других стран доступны:

  • Экспресс-доставка:

    • с вызовом курьера на ближайшее время. Варианты доставки могут отличаться в зависимости от сроков прибытия курьера.

    • с отложенным заказом (если необходимо указать желаемое время прибытия курьера к отправителю).

  • Грузовая доставка:

    • с вызовом курьера на ближайшее время;

    • с отложенным заказом.

  • Доставка в течение дня: отправление будет доставлено в выбранный временной интервал.

Все запросы к API Яндекс Доставки выполняются к хосту https://b2b.taxi.yandex.net.

Этапы заказа

Описание

Метод API

1. Получите первичную оценку стоимости доставки.

Вы отправляете запрос, система рассчитывает первичную стоимость доставки без создания заявки.

check-price

2. Создайте заявку на доставку.

Вы создаете заявку на выбранный вариант доставки по конкретному адресу.

claims/create

3. Узнайте результат оценки заказа.

Вы отправляете запрос. Если заявка может быть выполнена, в ответ придет актуальная стоимость заказа.
Если нет — в ответе будут причины, по которым заявка не может быть выполнена.

claims/info

4. Подтвердите заявку.

Если вы согласны с условиями доставки, вы подтверждаете заявку. После этого запускается поиск исполнителя.

claims/accept

5. Отслеживайте статусы заявки.

Вы отправляете запрос по одной или нескольким заявкам и получаете по ним информацию.

Подробнее читайте в разделе Методы API:

В случае проблем обратитесь к менеджеру Яндекс Доставки.

Отмена заказа

При необходимости заявку можно отменить:

  1. Узнайте условия отмены с помощью метода claims/cancel-info.

    Бесплатная отмена заказа доступна до прибытия курьера к отправителю (статус pickup_arrived). После прибытия курьера отмена заказа будет платной.

  2. Отмените заявку с помощью метода claims/cancel.

    Важно

    После передачи товара курьеру отменить заказ можно только через службу поддержки.

Предыдущая
Технические детали интеграции
Следующая
Статусная модель