square_api_client/models/search_orders_request.rs
1//! Model struct for SearchOrdersRequest type
2
3use serde::Serialize;
4
5use super::SearchOrdersQuery;
6
7/// This is a model struct for SearchOrdersRequest type.
8#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize)]
9pub struct SearchOrdersRequest {
10 pub location_ids: Option<Vec<String>>,
11 /// A pagination cursor returned by a previous call to this endpoint. Provide this cursor to
12 /// retrieve the next set of results for your original query. For more information, see
13 /// [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
14 pub cursor: Option<String>,
15 /// Query conditions used to filter or sort the results. Note that when retrieving additional
16 /// pages using a cursor, you must use the original query.
17 pub query: Option<SearchOrdersQuery>,
18 /// The maximum number of results to be returned in a single page. It is possible to receive
19 /// fewer results than the specified limit on a given page.
20 ///
21 /// Default: 500
22 pub limit: Option<i32>,
23 /// A Boolean that controls the format of the search results. If true, SearchOrders returns
24 /// OrderEntry objects. If false, SearchOrders returns complete order objects.
25 pub return_entries: bool,
26}