Struct square_api_client::models::SearchOrdersRequest

pub struct SearchOrdersRequest {
    pub location_ids: Option<Vec<String>>,
    pub cursor: Option<String>,
    pub query: Option<SearchOrdersQuery>,
    pub limit: Option<i32>,
    pub return_entries: bool,
}

This is a model struct for SearchOrdersRequest type.

Fields

location_ids: Option<Vec<String>>

cursor: Option<String>

A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of results for your original query. For more information, see Pagination.

query: Option<SearchOrdersQuery>

Query conditions used to filter or sort the results. Note that when retrieving additional pages using a cursor, you must use the original query.

limit: Option<i32>

The maximum number of results to be returned in a single page. It is possible to receive fewer results than the specified limit on a given page.

Default: 500

return_entries: bool

A Boolean that controls the format of the search results. If true, SearchOrders returns OrderEntry objects. If false, SearchOrders returns complete order objects.

Trait Implementations

impl Clone for SearchOrdersRequest

fn clone(&self) -> SearchOrdersRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchOrdersRequest

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

Formats the value using the given formatter.

impl Default for SearchOrdersRequest

fn default() -> SearchOrdersRequest

Returns the “default value” for a type.

impl PartialEq<SearchOrdersRequest> for SearchOrdersRequest

fn eq(&self, other: &SearchOrdersRequest) -> 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 SearchOrdersRequest

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 SearchOrdersRequest

impl StructuralEq for SearchOrdersRequest

impl StructuralPartialEq for SearchOrdersRequest