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

Возвращает отчет о заказах в формате JSON.

Формат запроса

POST https://app.tanker.yandex.net/api/tanker/report
 ? apikey=<string>
 & sdate=<DateTime>
 & edate=<DateTime>
 & [page=<integer>]

apikey*

Ключ для работы с API. Запросите его в Кабинет разработчика.

sdate*

Начальная граница периода отчета. Вычисляется по формуле:

{order.DateEnd} <= sdate AND {order.DateEnd} < edate

Задается в следующих форматах по Московскому региону: "dd.MM.yyyy HH:mm:ss", "dd.MM.yyyy"

edate*

Конечная граница периода отчета. Вычисляется по формуле:

{order.DateEnd} <= sdate AND {order.DateEnd} < edate

Задается в следующих форматах по Московскому региону: "dd.MM.yyyy HH:mm:ss", "dd.MM.yyyy"

page

Номер страницы результатов. По умолчанию 0.

При формировании отчета за период система отдает максимальное количество строк — 1000.

Если в ответе параметр IsNextPage содержит значение true, необходимо совершить повторный запрос для получения следующей страницы результатов.

* Обязательный параметр

Формат ответа

{
    "IsNextPage": "boolean", 
    "PageSize": "integer", 
    "PageIndex": "integer",
    "Items": "List<Order>"
}

IsNextPage

Флаг наличия следующей страницы результатов.

PageSize

Количество результатов на странице.

PageIndex

Номер страницы результатов.

Items

Список элементов.

Коды ответа

Код

Причина

Описание

200

OK

Успешный запрос.

400

BAD_REQUEST

Синтаксическая ошибка в запросе.

500

INTERNAL SERVER ERROR

Внутренняя ошибка сервера.

Ключ для работы с API. Запросите его в Кабинете разработчика.

Начальная граница периода отчета. Вычисляется по формуле:

{order.DateEnd} <= sdate AND {order.DateEnd} < edate

Задается в следующих форматах по Московскому региону: "dd.MM.yyyy HH:mm:ss", "dd.MM.yyyy"

Конечная граница периода отчета. Вычисляется по формуле:

{order.DateEnd} <= sdate AND {order.DateEnd} < edate

Задается в следующих форматах по Московскому региону: "dd.MM.yyyy HH:mm:ss", "dd.MM.yyyy"

Номер страницы результатов. По умолчанию 0.

При формировании отчета за период система отдает максимальное количество строк — 1000.

Если в ответе параметр IsNextPage содержит значение true, необходимо совершить повторный запрос для получения следующей страницы результатов.

*Обязательный параметр

Флаг наличия следующей страницы результатов.

Количество результатов на странице.

Номер страницы результатов.

Список элементов.