Skip to main content
GET
Batch order lookup
Use this endpoint to poll the status of many orders in one call. Supply custom_ids (the ids you assigned at purchase time) and/or order_ids (CSBoard order ids) as comma-separated lists. You must provide at least one of the two, and no more than 200 ids in total across both. Authentication required. Send your key as Authorization: Bearer csb_pub_....

Query parameters

string
Comma-separated custom ids you assigned at purchase time.
string
Comma-separated CSBoard order ids.
Provide at least one of custom_ids or order_ids. The combined total across both parameters must not exceed 200 ids.

Response fields

Order[]
required
Array of matching orders. Each Order has the same shape as in GET /v1/orders — including order_id, status, charged_total_usd, the refund object, and the per-item items breakdown.
Polling this endpoint by custom_id is the cheapest way to follow a batch. An order that ends cancelled or failed has already been refunded — refund.amount_usd tells you how much came back and refund.refunded_at when.

Example request

Example response

Error codes

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.

Query Parameters

custom_ids
string

Comma-separated custom ids you assigned at purchase time.

order_ids
string

Comma-separated CSBoard order ids.

Response

Matching orders.

data
object[]
required