Lightspeed Commerce Service Orders API

Service orders and Job management

Documentation GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /service_items/customer/{customer_id} List a customer's service items · List a customer's service items #

Ask an LLM

“Which items has a customer brought in for repair or service?”

“Can I page through the service items tied to one customer?”

Tell an agent

List the service items for customer {customer}.

Show up to {limit} service items for customer {customer}.

GET /service_statuses List service order statuses · List service statuses #

Ask an LLM

“What statuses can a service order move through in my store?”

“Can I see both the default and my custom service statuses?”

Tell an agent

List all service statuses.

Show my custom and system service order statuses.

POST /service_statuses Create a custom service status · Create a service status #

Ask an LLM

“How do I add a custom stage like 'Waiting for parts' to service orders?”

“Where does a newly created service status appear in the display order?”

Tell an agent

Create a service status called {name}.

Add custom service order status {name}.

DELETE /service_statuses/{id} Delete a custom service status · Delete a service status #

Ask an LLM

“Can I delete a custom service status that is no longer used?”

“Why can't a service status be deleted while orders still use it?”

Tell an agent destructive · confirm first

Delete service status {id}.

Remove the custom service order status {id}.

GET /service_statuses/{id} Get a service status · Get a service status #

Ask an LLM

“What are the details of one service status?”

“Can I check whether a service status is a system default or a custom one?”

Tell an agent

Get service status {id}.

Show me the service order status with ID {id}.

PATCH /service_statuses/{id} Rename or reorder a service status · Update a service status #

Ask an LLM

“Can I rename a custom service status?”

“How do I move a service status to a different position in the display order?”

Tell an agent

Rename service status {id} to {name}.

Move service status {id} to display position {order}.

GET /services List service orders · List services #

Ask an LLM

“What service orders are open across my store?”

“Can I page through all service orders?”

Tell an agent

List all service orders.

Show the next {limit} service orders after {after}.

POST /services Create a service order · Create a service order #

Ask an LLM

“How do I book a repair job for a customer at the register?”

“Can I assign a staff member and a custom status when creating a service order?”

Tell an agent

Create a service order for customer {customer} at outlet {outlet} on register {register}.

Open a service job for customer {customer} at outlet {outlet}, register {register}, assigned to {user}.

GET /services/{service_id} Get a service order · Get service #

Ask an LLM

“What is the current state of a particular service order?”

“Can I retrieve one service job with its item and notes?”

Tell an agent

Get service order {service}.

Show the details of service job {service}.

GET /services_agenda/outlet/{outlet_id} Get an outlet's service agenda · Get services agenda by outlet #

Ask an LLM

“What service work is scheduled at a store over the next few days?”

“Can the service agenda account for daylight saving in my timezone?”

Tell an agent

Show the service agenda for outlet {outlet} starting {start}.

Get {days} days of service agenda for outlet {outlet} from {start} in timezone {tz}.

Lightspeed Commerce Service Orders API

Operations 10

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification