Skip to content

Add services to a round

POST
/service-schedules/round
curl --request POST \
--url https://example.com/service-schedules/round \
--header 'Content-Type: application/json' \
--cookie __Host-bottle.session_token=<__Host-bottle.session_token> \
--data '{ "scheduleIds": [ "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" ], "date": "2026-03-01", "roundId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f" }'

Books each service for the day: one order for each door, with no lines, wanted that day and carrying every service booked there in its notes. With roundId each order goes on that round, which must be on the same day and not finished; with null they wait for a round that day, and Plan day picks them up. A service already on an open order, a tracked item no customer holds, and an item with no address in use are skipped and listed. An order that could not go on the round is listed in notMoved and waits for a round that day. Refused while a person is planning that day’s rounds, for an API key or connected app.

Media typeapplication/json
object
scheduleIds
required
Array<string>
>= 1 items <= 200 items
date
required
string format: date

Example

2026-03-01
roundId
required

UUID v7

string | null format: uuid

Example

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

What was booked, and what was skipped and why

Media typeapplication/json
object
orderIds
required
Array<string>
notMoved
required
Array<string>
booked
required
Array<string>
skipped
required
Array<object>
object
scheduleId
required

UUID v7

string format: uuid
reason
required

Not_found: no such service. booked: already on an open order. no_customer: a tracked item no customer holds. no_address: the item’s address is removed, or the customer has no address.

string
Allowed values: not_found booked no_customer no_address

Example

{
"orderIds": [
"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
],
"notMoved": [
"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
],
"booked": [
"019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
],
"skipped": [
{
"scheduleId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
"reason": "not_found"
}
]
}

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"
}
]
}