Перейти к основному содержанию
GET
Get a single order
Получите один заказ по его CSBoard order id. Ответ включает полную разбивку по предметам со статусом доставки, причинами возврата и сведениями о трейд-офере Steam. Требуется аутентификация. Отправьте ключ как Authorization: Bearer csb_pub_....

Path-параметры

string
обязательно
CSBoard order id, например ord_01J9Z3K8Q2.

Поля ответа

Ответ представляет собой один объект Order, имеющий ту же структуру, что и элементы в GET /v1/orders:
string
обязательно
string | null
string
обязательно
Одно из: completed, hold, delivering, pending, cancelled, failed.
string | null
string
обязательно
Всегда "USD".
number
обязательно
integer
обязательно
datetime | null
string
instant или manual. manual — трейд отправляет человек, до 12 часов, и всё это время заказ может быть в delivering без трейд-оффера. P2P-лот всегда manual.
datetime | null
Срок доставки; заполнен, только пока status — pending или delivering (у заказов в холде — null). Если продавец не успел, заказ отменяется и деньги возвращаются автоматически. См. POST /v1/orders/{id}/cancel.
string | null
Почему заказ не выполнен — код для ветвления логики, например recipient_inventory_private или listing_gone. Заполнен, только когда status — failed или cancelled. Список кодов может пополняться: незнакомое значение обрабатывайте как unavailable.
string | null
Кто должен действовать: recipient, seller, buyer или market. Заполнен, только когда status — failed или cancelled.
string | null
Одно предложение на английском: что произошло и что делать. Показывайте его как есть, а логику стройте по fail_reason — формулировка может меняться.
datetime
обязательно
datetime | null
OrderItem[]
обязательно
Разбивка по предметам. Каждый предмет содержит market_hash_name, price_usd, status (hold | delivering | delivered | returned), tradable_at, return_reason, steam_trade_offer_id и steam_trade_offer_finished_at.

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

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

Коды ошибок

Авторизации

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.

Параметры пути

id
string
обязательно

CSBoard order id.

Ответ

The order.

order_id
string
обязательно
status
enum<string>
обязательно
Доступные опции:
completed,
hold,
delivering,
pending,
cancelled,
failed
currency
string
обязательно
Пример:

"USD"

charged_total_usd
number
обязательно
item_count
integer
обязательно
created_at
string<date-time>
обязательно
items
object[]
обязательно
steam_id
string | null
custom_id
string | null

Your own id, if you set one at purchase time.

hold_until
string<date-time> | null
delivery_type
enum<string>

How the order ships. instant: a bot sends the Steam trade within minutes. manual: a person (or a slow desk) sends it, which can take up to 12 hours, so the order may stay delivering that long with no trade offer yet. A player's (P2P) lot is always manual.

Доступные опции:
instant,
manual
delivery_deadline_at
string<date-time> | null

The delivery deadline: 12 hours after purchase for manual delivery, the vendor's accept window otherwise. Set only while status is pending or delivering; null once the order is completed, cancelled or failed, and on a held order (it waits on hold_until). If the seller misses it, the order is cancelled and refunded automatically.

fail_reason
string | null

Why the order failed. Set when status is failed or cancelled, null otherwise. The recipient has to act on recipient_inventory_private, recipient_inventory_full, invalid_trade_url, recipient_cannot_trade, recipient_too_many_offers, offer_declined and offer_expired; the seller on seller_did_not_deliver, seller_cancelled and rolled_back; you on cancelled_by_buyer; the market on listing_gone, market_unavailable and unavailable. The list may grow: treat a value you do not know as unavailable.

Пример:

"recipient_inventory_private"

fail_side
enum<string> | null

Who has to act on the failure: recipient (the account the skins go to — fix it and buy again), seller or market (buy another listing), buyer (you cancelled). null unless status is failed or cancelled.

Доступные опции:
recipient,
seller,
buyer,
market,
null
fail_message
string | null

One English sentence: what happened and what to do. Safe to show to a person; branch on fail_reason, since the wording can change. null unless status is failed or cancelled.

Пример:

"The recipient's Steam inventory is private, so the trade could not be sent. Set Inventory to Public in the recipient's Steam privacy settings and buy again."

refund
object | null

Refund credited for this order, or null if none. A cancelled or failed order is ALWAYS refunded — this field is the receipt, so you never have to infer it from the status or reconcile against your balance.

updated_at
string<date-time> | null