Skip to main content
PATCH
Update order item status

Authorizations

x-api-key
string
header
required

Team API key for authentication. Your team role (provider/reseller/hybrid) determines which endpoints you can access.

Path Parameters

itemId
string
required

Body

application/json
status
enum<string>
required

New status for the order item. The usual path is accepted → active (or completed); rejected, cancelled and failed close the item. The item must currently be in a status that may move to the target, otherwise the request returns 409.

Available options:
pending,
handoff,
submitted_to_provider,
accepted,
rejected,
completed,
active,
cancelled,
failed
Example:

"accepted"

providerNotes
string

Notes from provider about this status update

Example:

"Order accepted. Customer will be contacted within 24 hours."

scheduledFor
string

Optional appointment or activation date/time, if one applies (ISO 8601)

Example:

"2025-01-15T10:00:00Z"

metadata
object

Additional metadata for this status update

Example:

Response

Order item status successfully updated