Object Index / Definition

You are viewing an old version of the API
Catalog​Query​Sorted​Attribute

Properties

Name Description
attribute_name
string

Required

The attribute whose value should be used as the sort key.

Min Length 1
initial_attribute_value
string

The first attribute value to be returned by the query. Ascending sorts will return only objects with this value or greater, while descending sorts will return only objects with this value or less. If unset, start at the beginning (for ascending sorts) or end (for descending sorts).

sort_order
string

The desired sort order, "ASC" (ascending) or "DESC" (descending).

Share Feedback

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