<- Object

Object

SegmentFilter

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

Link to section

Properties

Link to section

service_variation_id

string

Required

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

Min Length
1
Max Length
36
Link to section

team_member_id_filter

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 not in this list.
  • ALL: not supported.

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