Skip to main content
This page is part of Build a supplier portal. Paths are relative to /v1/projects/{projectId}/suppliers/me. Every call takes your API key and the supplier’s access token. See Sign-in and access.

Bookings and the attendance report

The client is shown as the service’s settings allow the supplier to see them — for example, a last initial instead of a last name, and no email or phone. Booking notes and the client’s own report are never returned. This section is the summary. For the agenda’s window and expand rules, viewerActions, every report outcome and refusal, and overdue reports, see Supplier day view and attendance reports.

The day’s agenda

  1. List the window:
    The list isn’t paginated, so keep the window short — a day or a week. Every expand value except client needs both dates, at most 93 days apart.
  2. Read viewerActions on each row: canCancel, canReschedule, and blockedReason when an action is blocked. The server computes them; use them to show or hide the cancel and move buttons.
  3. GET /bookings/{bookingId} for the detail.

File the report

After the booking ends, GET /bookings/{bookingId}/reports. reportable says whether a report may be filed now. ifAttended and ifNotAttended say which status each answer would move the booking to. They are judged from the booking alone, so an ifAttended of COMPLETED can still end DISPUTED. Then POST /bookings/{bookingId}/reports:
attended says whether the supplier attended. Filing settles the booking as the dashboard does: attended → COMPLETED, not attended → SUPPLIER_NO_SHOW. Attended becomes DISPUTED instead when the client has already reported that they didn’t attend. No read tells the supplier what the client said, and the report’s response carries no booking status. To show the outcome, re-read the booking with GET /bookings/{bookingId} rather than predicting it. See Attendance and disputes.

Rate the client

The supplier plane has no review route. To let a supplier rate a client, your server checks the booking is theirs with GET /suppliers/me/bookings/{bookingId}, then posts a SUPPLIER_TO_CLIENT review with the API key. Don’t check with the API-key GET /bookings/{bookingId}: it returns any booking in the project. See Collect reviews and show ratings.

Cancel and reschedule

Both return 200 with the updated booking, and email the client and the business. Your portal never refunds. A cancelled package session goes back on the package. Whether a supplier may do either is the service’s setting. The business sets it per service in participantSettings: may suppliers cancel, may they reschedule, and the notice window for each. There’s no separate permission for it.

Move a booking

  1. Read viewerActions.canReschedule on the booking. When it’s false, show blockedReason if there is one; otherwise say the business handles changes.
  2. Send the new start:
  3. On 409 SLOT_UNAVAILABLE, offer another time. On 409 VERSION_CONFLICT, re-read the booking and try again.
A move changes the time only. The length, supplier, location and zone stay.

Cancel a booking

reasonCode is one of CLIENT_REQUESTED, CLIENT_UNWELL, SUPPLIER_UNAVAILABLE, WEATHER, FACILITY_UNAVAILABLE, BOOKED_IN_ERROR or OTHER. The note stays on the booking’s history and is never emailed.

When a change is refused

For example, a move on a service that doesn’t allow it: