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

Object Index

You are viewing an old version of the API
FilterValue BETA

A filter to select resources based on an exact field value.

For any given value, the value can only be in one property. Depending on the field, either all properties can be set or only a subset will be available.

Refer to the documentation of the field.

Properties

Name Description
all
string [ ]

A list of terms that must be present on the field of the resource.

any
string [ ]

A list of terms where at least one of them must be present on the field of the resource.

none
string [ ]

A list of terms that must not be present on the field the resource

Share Feedback

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