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

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

"accepted"

providerNotes
string

Notes from provider about this status update

Example:

"Installation scheduled for next Tuesday"

scheduledFor
string

Scheduled date/time for installation or activation (ISO 8601)

Example:

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

metadata
object

Additional metadata for this status update

Example:

Response

Order item status successfully updated