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

Object Index

You are viewing an old version of the API
CatalogQueryExact

The query filter to return the serch result by exact match of the specified attribute name and value.

Properties

Name Description
attribute_name
string

Required

The name of the attribute to be searched. Matching of the attribute name is exact.

Min Length 1
attribute_value
string

Required

The desired value of the search attribute. Matching of the attribute value is case insensitive and can be partial. For example, if a specified value of "sma", objects with the named attribute value of "Small", "small" are both matched.

Share Feedback

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