Запрос отчетов по API

Данные отправляются в реальном времени, по факту завершения заказа попадают в выгрузку.

Запросы — не чаще, чем раз в минуту.

Получение токена

Выдается по запросу. Для получения токена обратитесь к своему менеджеру. Срок действия токена — 6 месяцев. Выпуск нового токена на ту же сеть инвалидирует предыдущий.

Экспорт заказов

Запрос:

pickerapp.eda.yandex.ru/partner/v1/orders/export

Пример ответа:

orders.csv

Экспорт информации о позициях заказов

Запрос:

pickerapp.eda.yandex.ru/partner/v1/orders/positions/export

Пример ответа:

order-positions.csv

Экспорт смен пикеров

Запрос:

pickerapp.eda.yandex.ru/partner/v1/shifts/export

Пример ответа:

shifts.csv

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

Внимание

Все фильтры являются параметрами в строке запроса.

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

  • startDate — дата, начаная с которой (включительно) будут выгружены заказы;
  • endDate — дата, до которой будут выгружены заказы;
  • orderId — внутренний ID заказа;
  • displayId — № заказа для сборщика;
  • pickerId — внутренний ID пикера, назначенного на заказы;
  • storeId* — внутренний ID магазина;
  • cityId* — внутренний ID города;
  • logisticServiceId* — внутренний ID логистической службы пикера;
  • integrationStatus — cтатус заказа от интеграции. Возможные значения: created / accepted / handed_over_for_picking / handed_over_for_delivery / delivered / canceled;
  • status — статус заказа, с которым закончил работу пикер: done — передан курьеру, canceled — отменен.

Фильтры для экспорта смен

  • pickerId — по внутреннему ID пикера;
  • storeId* — по внутреннему ID магазина;
  • start — по времени начала. Отдаются записи, у которых время начала не раньше данного (может быть позже);
  • end — по времени конца смены. Отдаются записи, у которых время конца не позже данного (может быть раньше);
  • isActive — только активные или неактивные смены;
  • logisticServiceId* — по логистической службе;
  • cityId* — по внутреннему ID города;
  • status: created / activated / finished / break — по статусу смены.

(*) — значения для фильтров не видны из интерфейса админки, получите запросами в api picker-backend.

Пример запроса со всеми возможными фильтрами, на примере экспорта жалоб (в формате curl)

curl --location --request GET 'picker-api.delivery-club.ru2/partner/v1/orders/complaints/export?startDate=2021-
12-12&endDate=2021-12-18&orderId=12345678&displayId=12-3456-
7890&pickerId=1234&storeId=1234&cityId=123&logisticServiceId=1&integrationStatus=canceled&status=done' \
--header 'Authorization: Bearer %token_stand_in%'

Частые вопросы

В CSV-файле вместо текста отображаются нечитаемые символы

Откройте файл одним из способов:

  1. Авторизуйтесь в своем аккаунте Google.

  2. Откройте Google Таблицы.

  3. В разделе Создать таблицу нажмите Пустая таблица.

  4. Нажмите Файл → Импортировать и перейдите на вкладку Добавить.

  5. Нажмите кнопку Обзор и откройте скачанный csv-шаблон.

  6. В появившемся окне нажмите Импортировать данные. Шаблон откроется и будет доступен для редактирования.

Важно

После редактирования сохраните файл в формате csv.

Если в CSV-файле вместо текста вы видите нечитаемые символы, измените его кодировку:

  1. Откройте программу Excel. Нажмите ФайлОткрыть и в открывшемся окне выберите скаченный CSV-файл.

  2. Откройте файл в Excel. Нажмите ДанныеПолучение внешних данныхИз текста и в открывшемся окне выберите скаченный CSV-файл.

  3. В открывшемся окне Мастер текстов (импорт) укажите формат данных с разделителями, установите кодировку UTF-8 и нажмите Далее.

Подробнее читайте в Официальной документации Excel.