Skip to content

List the services booked on an order

GET
/orders/{id}/services
curl --request GET \
--url https://example.com/orders/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/services \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token>

The equipment booked for a service on an order added from the Servicing list, and what the driver recorded at the stop: done, with the next due date it set, or not done, with why. Empty for an order with no services booked.

id
required

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

The services

Media typeapplication/json
object
items
required
Array<object>
object
jobId
required

UUID v7

string format: uuid
scheduleId
required

UUID v7

string format: uuid
itemId
required

UUID v7

string format: uuid
typeName
required
string
serial
required
string | null
planName
required
string
dueRule
required

Day: due on the date. month: due within the month; the date held is the 1st of the month.

string
Allowed values: day month
dueOn
required
string format: date
outcome
required
string | null
Allowed values: passed failed not_done
reason
required

Not_in: the customer was not in. item_missing: the item was not there. failed: it failed the service. other: said in the note.

string | null
Allowed values: not_in item_missing failed other
note
required
string | null
doneOn
required
string | null format: date
nextDueOn
required
string | null format: date

Example

{
"items": [
{
"jobId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"scheduleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"itemId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"dueRule": "day",
"dueOn": "2026-03-01",
"outcome": "passed",
"reason": "not_in",
"doneOn": "2026-03-01",
"nextDueOn": "2026-03-01"
}
]
}

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not an owner or admin, missing scope, or the plan does not open Equipment servicing

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Not found, or Equipment servicing is not available to this business

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Equipment servicing is switched off, other equipment already has that detail, or the cylinder already has servicing set up

Media typeapplication/json
object
error
required
string
message
required
string

Example

{
"error": "not_found",
"message": "Customer not found"
}

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string

Example

{
"error": "validation",
"issues": [
{
"path": "email",
"message": "Invalid email"
}
]
}