Requesting reports via API

Data is sent in real time and is uploaded upon completion of the order.

Requests — no more than once per minute.

Receiving a token

Issued on request. To receive a token, contact your manager. The token is valid for 6 months. The release of a new token on the same network invalidates the previous one.

Orders export

Request:

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

Sample Answer:

orders.csv

Exporting order item information

Request:

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

Sample Answer:

order-positions.csv

Export of picker shifts

Request:

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

Sample Answer:

shifts.csv

Filters available

The method for exporting order information uses the same filters:

• startDate — the date from which (inclusive) orders will be unloaded;
• endDate — date until which orders will be unloaded;
• orderId — internal order ID;
• displayId — order number for the assembler;
• pickerId — internal ID of the picker assigned to orders;
• storeId* — internal store ID;
• cityId* — internal city ID;
• logisticServiceId* — internal ID of the picker’s logistics service;
• integrationStatus — order status from integration. Possible meanings: created / accepted / handed_over_for_picking / handed_over_for_delivery / delivered / canceled;
• status — status of the order that the picker finished working with: done — transferred to the courier, canceled.

Filters for shift export

• pickerId — by the internal ID of the picker;
• storeId* — by internal store ID;
• start — according to the starting time. Records are returned whose start time is no earlier than this (maybe later);
• end — at the end of the shift. Records are returned whose end time is not later than the given one (maybe earlier);
• isActive — only active or inactive shifts;
• logisticServiceId* — by logistics service;
• cityId* — by internal city ID;
• status: created / activated / finished / break — by shift status.

(*) — values ​​for filters are not visible from the Admin interface, get them with requests to the api picker-backend.

An example of a request with all possible filters, using the example of exporting complaints (in curl format)

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%'