246 lines
6.7 KiB
Markdown
246 lines
6.7 KiB
Markdown
---
|
|
name: bookings-routes
|
|
description: Handle 24 OpenAPI operation(s) under /v2/bookings for the bookings route group.
|
|
---
|
|
|
|
# bookings API Routes
|
|
|
|
Handle 24 OpenAPI operation(s) under /v2/bookings for the bookings route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### list_bookings
|
|
|
|
- Operation ID: `list_bookings`
|
|
- Route: `GET /v2/bookings`
|
|
- Mode: READ
|
|
- Summary: ListBookings
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `cursor` in `query`
|
|
- `customer_id` in `query`
|
|
- `team_member_id` in `query`
|
|
- `location_id` in `query`
|
|
- `start_at_min` in `query`
|
|
- `start_at_max` in `query`
|
|
|
|
### create_booking
|
|
|
|
- Operation ID: `create_booking`
|
|
- Route: `POST /v2/bookings`
|
|
- Mode: WRITE
|
|
- Summary: CreateBooking
|
|
- Body: JSON request body accepted.
|
|
|
|
### search_availability
|
|
|
|
- Operation ID: `search_availability`
|
|
- Route: `POST /v2/bookings/availability/search`
|
|
- Mode: WRITE
|
|
- Summary: SearchAvailability
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_retrieve_bookings
|
|
|
|
- Operation ID: `bulk_retrieve_bookings`
|
|
- Route: `POST /v2/bookings/bulk-retrieve`
|
|
- Mode: WRITE
|
|
- Summary: BulkRetrieveBookings
|
|
- Body: JSON request body accepted.
|
|
|
|
### retrieve_business_booking_profile
|
|
|
|
- Operation ID: `retrieve_business_booking_profile`
|
|
- Route: `GET /v2/bookings/business-booking-profile`
|
|
- Mode: READ
|
|
- Summary: RetrieveBusinessBookingProfile
|
|
|
|
### list_booking_custom_attribute_definitions
|
|
|
|
- Operation ID: `list_booking_custom_attribute_definitions`
|
|
- Route: `GET /v2/bookings/custom-attribute-definitions`
|
|
- Mode: READ
|
|
- Summary: ListBookingCustomAttributeDefinitions
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `cursor` in `query`
|
|
|
|
### create_booking_custom_attribute_definition
|
|
|
|
- Operation ID: `create_booking_custom_attribute_definition`
|
|
- Route: `POST /v2/bookings/custom-attribute-definitions`
|
|
- Mode: WRITE
|
|
- Summary: CreateBookingCustomAttributeDefinition
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_booking_custom_attribute_definition
|
|
|
|
- Operation ID: `delete_booking_custom_attribute_definition`
|
|
- Route: `DELETE /v2/bookings/custom-attribute-definitions/{key}`
|
|
- Mode: WRITE
|
|
- Summary: DeleteBookingCustomAttributeDefinition
|
|
- Parameters:
|
|
- `key` in `path` required
|
|
|
|
### retrieve_booking_custom_attribute_definition
|
|
|
|
- Operation ID: `retrieve_booking_custom_attribute_definition`
|
|
- Route: `GET /v2/bookings/custom-attribute-definitions/{key}`
|
|
- Mode: READ
|
|
- Summary: RetrieveBookingCustomAttributeDefinition
|
|
- Parameters:
|
|
- `key` in `path` required
|
|
- `version` in `query`
|
|
|
|
### update_booking_custom_attribute_definition
|
|
|
|
- Operation ID: `update_booking_custom_attribute_definition`
|
|
- Route: `PUT /v2/bookings/custom-attribute-definitions/{key}`
|
|
- Mode: WRITE
|
|
- Summary: UpdateBookingCustomAttributeDefinition
|
|
- Parameters:
|
|
- `key` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_delete_booking_custom_attributes
|
|
|
|
- Operation ID: `bulk_delete_booking_custom_attributes`
|
|
- Route: `POST /v2/bookings/custom-attributes/bulk-delete`
|
|
- Mode: WRITE
|
|
- Summary: BulkDeleteBookingCustomAttributes
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_upsert_booking_custom_attributes
|
|
|
|
- Operation ID: `bulk_upsert_booking_custom_attributes`
|
|
- Route: `POST /v2/bookings/custom-attributes/bulk-upsert`
|
|
- Mode: WRITE
|
|
- Summary: BulkUpsertBookingCustomAttributes
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_location_booking_profiles
|
|
|
|
- Operation ID: `list_location_booking_profiles`
|
|
- Route: `GET /v2/bookings/location-booking-profiles`
|
|
- Mode: READ
|
|
- Summary: ListLocationBookingProfiles
|
|
- Parameters:
|
|
- `limit` in `query`
|
|
- `cursor` in `query`
|
|
|
|
### retrieve_location_booking_profile
|
|
|
|
- Operation ID: `retrieve_location_booking_profile`
|
|
- Route: `GET /v2/bookings/location-booking-profiles/{location_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveLocationBookingProfile
|
|
- Parameters:
|
|
- `location_id` in `path` required
|
|
|
|
### list_team_member_booking_profiles
|
|
|
|
- Operation ID: `list_team_member_booking_profiles`
|
|
- Route: `GET /v2/bookings/team-member-booking-profiles`
|
|
- Mode: READ
|
|
- Summary: ListTeamMemberBookingProfiles
|
|
- Parameters:
|
|
- `bookable_only` in `query`
|
|
- `limit` in `query`
|
|
- `cursor` in `query`
|
|
- `location_id` in `query`
|
|
|
|
### bulk_retrieve_team_member_booking_profiles
|
|
|
|
- Operation ID: `bulk_retrieve_team_member_booking_profiles`
|
|
- Route: `POST /v2/bookings/team-member-booking-profiles/bulk-retrieve`
|
|
- Mode: WRITE
|
|
- Summary: BulkRetrieveTeamMemberBookingProfiles
|
|
- Body: JSON request body accepted.
|
|
|
|
### retrieve_team_member_booking_profile
|
|
|
|
- Operation ID: `retrieve_team_member_booking_profile`
|
|
- Route: `GET /v2/bookings/team-member-booking-profiles/{team_member_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveTeamMemberBookingProfile
|
|
- Parameters:
|
|
- `team_member_id` in `path` required
|
|
|
|
### retrieve_booking
|
|
|
|
- Operation ID: `retrieve_booking`
|
|
- Route: `GET /v2/bookings/{booking_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveBooking
|
|
- Parameters:
|
|
- `booking_id` in `path` required
|
|
|
|
### update_booking
|
|
|
|
- Operation ID: `update_booking`
|
|
- Route: `PUT /v2/bookings/{booking_id}`
|
|
- Mode: WRITE
|
|
- Summary: UpdateBooking
|
|
- Parameters:
|
|
- `booking_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### cancel_booking
|
|
|
|
- Operation ID: `cancel_booking`
|
|
- Route: `POST /v2/bookings/{booking_id}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: CancelBooking
|
|
- Parameters:
|
|
- `booking_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_booking_custom_attributes
|
|
|
|
- Operation ID: `list_booking_custom_attributes`
|
|
- Route: `GET /v2/bookings/{booking_id}/custom-attributes`
|
|
- Mode: READ
|
|
- Summary: ListBookingCustomAttributes
|
|
- Parameters:
|
|
- `booking_id` in `path` required
|
|
- `limit` in `query`
|
|
- `cursor` in `query`
|
|
- `with_definitions` in `query`
|
|
|
|
### delete_booking_custom_attribute
|
|
|
|
- Operation ID: `delete_booking_custom_attribute`
|
|
- Route: `DELETE /v2/bookings/{booking_id}/custom-attributes/{key}`
|
|
- Mode: WRITE
|
|
- Summary: DeleteBookingCustomAttribute
|
|
- Parameters:
|
|
- `booking_id` in `path` required
|
|
- `key` in `path` required
|
|
|
|
### retrieve_booking_custom_attribute
|
|
|
|
- Operation ID: `retrieve_booking_custom_attribute`
|
|
- Route: `GET /v2/bookings/{booking_id}/custom-attributes/{key}`
|
|
- Mode: READ
|
|
- Summary: RetrieveBookingCustomAttribute
|
|
- Parameters:
|
|
- `booking_id` in `path` required
|
|
- `key` in `path` required
|
|
- `with_definition` in `query`
|
|
- `version` in `query`
|
|
|
|
### upsert_booking_custom_attribute
|
|
|
|
- Operation ID: `upsert_booking_custom_attribute`
|
|
- Route: `PUT /v2/bookings/{booking_id}/custom-attributes/{key}`
|
|
- Mode: WRITE
|
|
- Summary: UpsertBookingCustomAttribute
|
|
- Parameters:
|
|
- `booking_id` in `path` required
|
|
- `key` in `path` required
|
|
- Body: JSON request body accepted.
|