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

Object Index

You are viewing an old version of the API
SegmentFilter

A query filter to search for buyer-accessible appointment segments by.

Properties

Name Description
service_variation_id
string

Required

The ID of the CatalogItemVariation object representing the service booked in this segment.

Min Length 1 Max Length 36
team_member_id_filter
FilterValue

A query filter to search for buyer-accessible appointment segments with service-providing team members matching the specified list of team member IDs. Supported query expressions are

  • ANY: return the appointment segments with team members whose IDs match any member in this list.
  • NONE: return the appointment segments with team members whose IDs are in this list.
  • ALL: not supported.

When no expression is specified, any service-providing team member is eligible to fulfill the Booking.