• Example searches: “transaction”, “CreateOrder”, “/v2/locations”, “inventory”, “delete customer”

Object Index

You are viewing an old version of the API
SearchAvailabilityFilter BETA

A query filter to search for availabilities by.

Properties

Name Description
start_at_range
TimeRange

Required

The query expression to search for availabilities matching the specified range of starting times. The range must be at least 24 hours and at most 31 days in length.

location_id
string

The query expression to search for availabilities matching the specified seller location IDs. This query expression is not applicable when booking_id is present.

segment_filters
SegmentFilter [ ]

The list of segment filters to apply. A query with n segment filters returns availabilities with n segments per availability. It is not applicable when booking_id is present.

booking_id
string

The query expression to search for availabilities for an existing booking by matching the specified booking_id value. This is commonly used to reschedule an appointment. If this expression is specified, the location_id and segment_filters expressions are not allowed.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?