Перейти к основному содержанию
GET
List purchase history
Эндпоинт orders возвращает историю ваших покупок, сначала самые новые, с keyset-пагинацией. Фильтруйте по временному окну и по статусу, затем переходите к более старым страницам, передавая meta.next_cursor обратно как cursor. Каждый заказ содержит разбивку по предметам со статусом доставки. Требуется аутентификация. Отправьте ключ как Authorization: Bearer csb_pub_....

Query-параметры

integer
по умолчанию:"50"
Результатов на странице. Минимум 1, максимум 100.
integer
Возвращать только заказы, созданные не раньше этого Unix-таймстампа (в секундах).
integer
Возвращать только заказы, созданные не позже этого Unix-таймстампа (в секундах).
string
Фильтр по статусу заказа. Одно из: completed, hold, delivering, pending, cancelled, failed.
string
Keyset-курсор из meta.next_cursor предыдущего ответа. Передайте его, чтобы получить следующую страницу.

Поля ответа

Order[]
обязательно
Массив заказов для этой страницы.
object
обязательно

Пример запроса

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

Почему заказ не выполнен

Заказ со статусом failed или cancelled объясняет причину в трёх полях. При любом другом статусе все три равны null.
  • fail_reason — код для ветвления логики, из таблицы ниже.
  • fail_side — кто должен действовать: recipient, seller, buyer или market.
  • fail_message — одно предложение на английском: что произошло и что делать. Показывайте его человеку, а логику стройте по fail_reason.
Список может пополняться. Незнакомый вам fail_reason обрабатывайте как unavailable. return_reason на уровне предмета не изменился. Заказ со статусом failed, сокращённый до нужных здесь полей:

Коды ошибок

Авторизации

Authorization
string
header
обязательно

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile. Calls made with a key are metered only by that key's own limits — there is no per-IP limit on top — and every answer carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and X-RateLimit-Bucket for the bucket the call spent. See Rate limits.

Параметры запроса

limit
integer
по умолчанию:50

Results per page. 1–100. Default 50.

Требуемый диапазон: 1 <= x <= 100
start_unix_time
integer

Only orders created at or after this Unix timestamp (seconds).

end_unix_time
integer

Only orders created at or before this Unix timestamp (seconds).

status
enum<string>

Filter by order status.

Доступные опции:
completed,
hold,
delivering,
pending,
cancelled,
failed
cursor
string

Keyset cursor from a previous response's meta.next_cursor.

Ответ

A page of orders.

data
object[]
обязательно
meta
object
обязательно