Интеграция с помощью API

Примеры использования API

Быстро интегрировать магазин с Яндекс.Доставкой

Этот вариант подходит для интеграции небольших магазинов. С помощью него вы получите возможность:

  1. Узнавать возможные способы доставки заказа.

  2. Передавать в систему Яндекс.Доставки данные, необходимые для создания заказа.

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

Последовательность методов
  1. SearchDeliveryList — позволяет получить варианты доставки заказа.

    Чтобы получить правильный адрес и почтовый индекс, используйте методы autoComplete и getIndex.

  2. Полученные данные от searchDeliveryList используйте в методе createOrder. Он позволяет создать черновик заказа, который доступен в личном кабинете Яндекс.Доставки.

Передавать заказы в службы доставки

Вариант дополняет предыдущий и подходит для магазинов, которые обрабатывают от 30 заказов в день. Он позволит вам:

  1. Создавать заказы в системе Яндекс.Доставки.

  2. Отправлять заказы в службы доставки.

  3. Загружать ярлыки для заказов.

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

Последовательность методов
  1. ConfirmSenderOrders — позволяет создать заказ в системе Яндекс.Доставки и отправить его в службу доставки.

  2. GetSenderOrderLabel — позволяет получить ярлык заказа в формате PDF или HTML.

Автоматизировать создание заявок на отгрузку

Вариант дополняет предыдущие и позволит вам создавать заявки на забор и самопривоз (в системе Яндекс.Доставки).

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

Последовательность методов

  1. GetDeliveries — позволяет получить список доступных служб доставки.

  2. GetIntervals — позволяет получить доступные временные интервалы для забора.

  3. CreateWithdraw — позволяет создать заявку на забор (если еще нет заявки на ту же дату).

Полностью автоматизировать создание заказа

Вариант дополняет предыдущие и позволит вам:

  1. Подтверждать отгрузку заказов (в системе Яндекс.Доставки).

  2. Загружать сопроводительные документы для заказов.

Последовательность методов
  1. ConfirmSenderParcels — позволяет подтвердить отгрузку (нужно выполнять строго в день отгрузки).

  2. GetSenderParcelDocs — позволяет получить сопроводительные документы для заказов в отгрузке.

Автоматизировать изменение и отмену заказов

Этот набор методов позволит вам:

  • Редактировать черновики заказов.

  • Отменять заказы в своей системе учета и передавать эти данные в систему Яндекс.Доставки.

  • Отменять заказы и создавать на их основе новые.

Методы
  • UpdateOrder — позволяет изменить черновик заказа. Чтобы изменить уже оформленный заказ, отмените его и создайте новый.

  • DeleteOrder — позволяет отменить заказ, если отгрузка с ним еще не подтверждена.

Отслеживать статусы заказов

Этот набор методов позволит вам:

  • Узнавать статусы для всех своих заказов.

  • Получать историю статусов для одного или нескольких заказов.

  • Искать заказы с определенными статусами.

Методы
  • GetSenderOrders — позволяет получить список всех заказов магазина. Идентификаторы заказов используются в методах getSenderOrderStatus, getSenderOrderStatuses и searchSenderOrdersStatuses.

  • GetSenderOrderStatus — позволяет получить текущий статус заказа.

  • GetSenderOrderStatuses — позволяет получить историю статусов заказа, а также найти заказы с заданными статусами.

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

Получить справочную информацию

Используйте эти методы для получения дополнительной информации:

  • GetSenderInfo — позволяет получить информацию о магазине из аккаунта в Яндекс.Доставке.

  • GetRequisiteInfo — позволяет получить реквизиты магазина.

  • GetWarehouseInfo — позволяет получить информацию о складе магазина.

  • GetOrderInfo — позволяет получить информацию о заказе.

Получение токена и ключей для работы через API

Чтобы получить идентификационный токен и API-ключи:

  1. В личном кабинете нажмите ссылку Настройки в правом верхнем углу страницы.

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

  3. Нажмите ссылку получить.