POST /v2/bookings
Creates a booking.
Servers
- https://connect.squareup.com
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
booking |
Object | Yes |
Represents a booking as a time-bound service contract for a seller's staff member to provide a specified service at a given location to a requesting customer in one or more appointment segments. |
booking.customer_note |
String | No |
The free-text field for the customer to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a relevant CatalogObject instance. |
booking.id |
String | No |
A unique ID of this object representing a booking. |
booking.customer_id |
String | No |
The ID of the Customer object representing the customer attending this booking |
booking.location_id |
String | No |
The ID of the Location object representing the location where the booked service is provided. |
booking.appointment_segments[] |
Array | No |
A list of appointment segments for this booking. |
booking.appointment_segments[].team_member_id |
String | Yes |
The ID of the TeamMember object representing the team member booked in this segment. |
booking.appointment_segments[].service_variation_id |
String | Yes |
The ID of the CatalogItemVariation object representing the service booked in this segment. |
booking.appointment_segments[].duration_minutes |
Integer | Yes |
The time span in minutes of an appointment segment. |
booking.appointment_segments[].service_variation_version |
Integer | Yes |
The current version of the item variation representing the service booked in this segment. |
booking.seller_note |
String | No |
The free-text field for the seller to supply notes about the booking. For example, the note can be preferences that cannot be expressed by supported attributes of a specific CatalogObject instance. This field should not be visible to customers. |
booking.version |
Integer | No |
The revision number for the booking used for optimistic concurrency. |
booking.start_at |
String | No |
The timestamp specifying the starting time of this booking, in RFC 3339 format. |
booking.status |
String | No |
The status of the booking, describing where the booking stands with respect to the booking state machine. |
booking.created_at |
String | No |
The timestamp specifying the creation time of this booking, in RFC 3339 format. |
booking.updated_at |
String | No |
The timestamp specifying the most recent update time of this booking, in RFC 3339 format. |
idempotency_key |
String | No |
A unique key to make this request an idempotent operation. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.