API Reference

Update a service status

patch
https://{domain_prefix}.retail.lightspeed.app/api/2026-07/service_statuses/

Partially updates a custom service status. Only provided fields are updated.

System default statuses cannot be modified.

Only available with the Service Orders module enabled.

🔒 Requires: services:write scope

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the service status

Body Params
integer | null

New display order. Can be set to null to clear it.

string

New human-readable name for the status. If provided, must not be blank.

Responses

Updated 18 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 18 days ago

Did this page help you?