Перейти к основному содержанию
GET
Batch order lookup
Используйте этот эндпоинт, чтобы за один вызов опросить статус сразу нескольких заказов. Передайте custom_ids (id, которые вы назначили при покупке) и/или order_ids (CSBoard order id) в виде списков через запятую. Нужно передать хотя бы один из двух параметров и в сумме не более 200 id. Требуется аутентификация. Отправьте ключ как Authorization: Bearer csb_pub_....

Query-параметры

string
Назначенные вами при покупке custom id через запятую.
string
CSBoard order id через запятую.
Передайте хотя бы один из параметров custom_ids или order_ids. Суммарное количество id по обоим параметрам не должно превышать 200.

Поля ответа

Order[]
обязательно
Массив подходящих заказов. Каждый Order имеет ту же структуру, что и в GET /v1/orders — включая order_id, status, charged_total_usd, delivery_type, delivery_deadline_at, fail_reason, fail_side, fail_message и разбивку по предметам items. Коды причин перечислены в разделе «Почему заказ не выполнен».

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

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

Коды ошибок

Авторизации

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.

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

custom_ids
string

Comma-separated custom ids you assigned at purchase time.

order_ids
string

Comma-separated CSBoard order ids.

Ответ

Matching orders.

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