Object Index / Definition

You are viewing an old version of the API
Search​Orders​Sort

Sorting criteria for a SearchOrders request

Results can only be sorted by a timestamp field.

Properties

Name Description
sort_field
string

Required

The field to sort by.

Important: When using a DateTimeFilter, sort_field must match the timestamp field that the DateTimeFilter uses to filter. For example, If you set your sort_field to CLOSED_AT and you use a DateTimeFilter, your DateTimeFilter must filter for orders by their CLOSED_AT date. If this field does not match the timestamp field in DateTimeFilter, SearchOrders will return an error.

Default: CREATED_AT.

sort_order
string

The chronological order in which results are returned. Defaults to DESC.

Share Feedback

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