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

Object Index

You are viewing an old version of the API
CustomerTextFilter BETA

A filter to select customers based on exact or fuzzy matching of customer attributes against a specified query.

Depending on customer attributes, the filter can be case sensitive. This filter can be either exact or fuzzy. It cannot be both.

Properties

Name Description
exact
string

Use the exact filter to select customers whose attributes match exactly the specified query.

fuzzy
string

Use the fuzzy filter to select customers whose attributes match the specified query in a fuzzy manner. When the fuzzy option is used, search queries are tokenized, and then each query token must be matched somewhere in the searched attribute. For single token queries, this is effectively the same behavior as a partial match operation.

Share Feedback

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