Skip to main content
POST
Change order status

Authorizations

x-api-key
string
header
required

API key minted in the MarketBox dashboard. Scope is restricted to the projects you select at creation time. Every route needs the key's standard API access (*) except POST /v1/projects/{projectId}/events, which needs events:write; a key without * is refused with 403 CAPABILITY_NOT_GRANTED.

Path Parameters

projectId
string
required

The project (tenant) that owns the resource. Every resource in this API is scoped to a project, and your API key is restricted to the projects it was issued for — a project outside that scope returns 403.

Minimum string length: 1
Example:

"prj_01kv60qgnef2kt3pvqgwmkbzfr"

orderId
string
required

The order — the commercial record. Order items are drawn down into bookings.

Minimum string length: 1
Example:

"ord_01kv8m92p4jcrywn14znp8cym0"

Body

application/json

Status change

status
enum<string>
required
Available options:
DRAFT,
PENDING,
PAID,
CANCELLED
cancellationReason
string

Required when status is CANCELLED; omitting it then is a 400. Why the order was cancelled.

Minimum string length: 1

Response

Updated order

data
object
required