Struct square_api_client::models::SearchOrdersSort

pub struct SearchOrdersSort {
    pub sort_field: Option<SearchOrdersSortField>,
    pub sort_order: Option<SortOrder>,
}

Sorting criteria for a SearchOrders request.

Results can only be sorted by a timestamp field.

Fields

sort_field: Option<SearchOrdersSortField>

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 returns an error.

Default: CREATED_AT.

sort_order: Option<SortOrder>

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

Trait Implementations

impl Clone for SearchOrdersSort

fn clone(&self) -> SearchOrdersSort

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchOrdersSort

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchOrdersSort

fn default() -> SearchOrdersSort

Returns the “default value” for a type.

impl PartialEq<SearchOrdersSort> for SearchOrdersSort

fn eq(&self, other: &SearchOrdersSort) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchOrdersSort

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SearchOrdersSort

impl StructuralEq for SearchOrdersSort

impl StructuralPartialEq for SearchOrdersSort