A customer segment (also called a smart group) is a dynamic collection of customers that are defined based on a set of filter criteria.
Customer Segments API

Manage Customers by Segments

A customer segment (also called a Smart Group) is a dynamic collection of customers who meet a set of filter criteria. While sellers are in control of defining segments and their criteria, membership in a segment is dynamically adjusted based on the filter criteria. For example, a seller can create a "Visited more than 10 times" segment based on a "visits greater than 10" filter. The membership in the segment then updates dynamically as customers pass the threshold of 10 visits.

To learn how sellers create customer segments, see Manage Customer Groups and Filters.

Note

Membership in customer groups behaves differently than membership in customer segments. Customers are explicitly added to customer groups by the seller or developer. For more information, see Manage Customers by Group.

When retrieving a customer profile, you can find the segments the customer belongs to using the following field:

  • segment_ids. A list of all the customer segments to which the customer currently belongs.

For information about working with customer profiles, see Manage Customers and Integrate with Other Services.

You can use the Customer Segments API to list and retrieve customer segment definitions. This lets you find and track basic information (such as name and created_at) about the segments to which customers belong. For more information, see Use Customer Segments.

Sellers can define segments in the Seller Dashboard or Square Point of Sale. The Customer Segments API cannot be used to create or manage customer segment definitions or to search for customers based on their segment membership.

If you need more assistance, contact Developer Support or ask for help in the Developer Forums.