Skip to main content
POST
Error

Authorizations

Authorization
string
header
required

Authorization: Bearer <token>. Accepts EITHER a Keycloak access token (scopes-in-token) OR an opaque POS session token; both resolve to the same pos.* scope vocabulary the route guards enforce.

Body

application/json
id
string
required

Caller-supplied unique appointment (RDV) id; a duplicate 409s.

Minimum string length: 1
associateId
string
required

Sales associate the customer is booked with.

Minimum string length: 1
customerId
string
required

Customer the rendez-vous is for.

Minimum string length: 1
storeId
string
required

Store the appointment takes place in.

Minimum string length: 1
startsAt
string<date-time>
required

ISO 8601 inclusive slot start; must be in the future.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
endsAt
string<date-time>
required

ISO 8601 exclusive slot end; must be after startsAt.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

The booked appointment in its requested state.

The booked appointment in its requested state.

id
string
required
associateId
string
required
customerId
string
required
storeId
string
required
startsAt
string
required
endsAt
string
required
status
enum<string>
required
Available options:
requested,
confirmed,
completed,
cancelled,
no-show
actorId
string
required
bookedAt
string
required