Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Service Orders

Create a service status

Creates a new custom service status for the retailer. The new status is appended at the end of the display order. Use the PATCH endpoint to change its position after creation.

Only available with the Service Orders module enabled.

🔒 Requires: services:write scope

post/service_statuses

Request body

namestring required

Human-readable name for the status.

Response

Service status created successfully

created_atstring date-time

The date and time the status was created.

display_namestring

Human-readable name of the status.

display_orderinteger nullable

The order in which this status appears in the UI. Null if not set.

idstring

The unique ID of the status.

retailer_idstring

The retailer this status belongs to.

status_keystring

The underlying key mapping this status to a system status (e.g. NEW, IN_PROGRESS).

system_defaultboolean

Whether this is a system-managed default status.

updated_atstring date-time

The date and time the status was last updated.