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

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

Подробное описание методов вы можете найти в документации API.

    Задача 1. Интегрировать магазин с Яндекс.Доставкой, прилагая минимум усилий

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

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

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

    3. Создавать черновики заказов в системе Яндекс.Доставки. Эти черновики доступны в личном кабинете.

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

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

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

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

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

    1. Переводить заказы в статус «Создан» (в системе Яндекс.Доставки).

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

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

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

    Последовательность методов
    1. ConfirmSenderOrders  — отправляет заказ в службу доставки и создает для него отгрузку (или прикрепляет заказ к уже существующей).

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

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

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

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

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

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

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

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

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

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

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

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

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

    Задача 5. Автоматизировать изменение и отмену заказов

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

    • Редактировать заказы в статусе «Черновик».

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

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

    Методы
    • UpdateOrder  — изменяет заказ в статусе «Черновик». Чтобы изменить заказ в другом статусе, отмените его и создайте новый.

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

    Задача 6. Отслеживать статусы заказов

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

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

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

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

    Методы

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

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

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

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

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

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

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

    Получить идентификационный токен и API-ключи можно в личном кабинете. Для этого:

    1. Перейдите по ссылке Настройки в правом верхнем углу страницы, затем перейдите на вкладку Интеграция → API.

    2. Нажмите получить в соответствующем блоке.