Skip to main content
POST
/
orders
/
{id}
/
claim
Claim a held order
curl --request POST \
  --url https://csboard.com/v1/orders/{id}/claim \
  --header 'Authorization: Bearer <token>'
{
  "order_id": "ord_01J9Z3K8Q2",
  "status": "delivering",
  "claimed": true,
  "steam_trade_offer_id": "5512345678"
}

Authorizations

Authorization
string
header
required

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile.

Path Parameters

id
string
required

CSBoard order id of the held order to claim.

Response

Claim accepted. claimed: true means the trade was released now; claimed: false means this order delivers automatically and no action was needed.

order_id
string
required
status
enum<string>
required
Available options:
delivering,
hold
claimed
boolean
required
steam_trade_offer_id
string | null

Present when claimed just released a trade offer.

detail
string

Present on the auto-delivering no-op case.