Struct OrderFilterParams 

pub struct OrderFilterParams {
    pub limit: Option<u32>,
    pub offset: Option<u32>,
    pub after: Option<String>,
    pub customer_id: Option<String>,
    pub status: Option<String>,
    pub payment_status: Option<String>,
    pub fulfillment_status: Option<String>,
    pub from_date: Option<String>,
    pub to_date: Option<String>,
}

Query parameters for GET /api/v1/orders with filtering.

Fields

limit: Option<u32>

Maximum number of results to return (default: 50).

offset: Option<u32>

Number of results to skip (default: 0). Ignored when after cursor is set.

after: Option<String>

Cursor for keyset pagination (opaque token from next_cursor).

customer_id: Option<String>

Filter by customer ID (UUID).

status: Option<String>

Filter by order status (pending, confirmed, shipped, delivered, cancelled).

payment_status: Option<String>

Filter by payment status (pending, paid, partially_refunded, refunded).

fulfillment_status: Option<String>

Filter by fulfillment status (unfulfilled, partial, fulfilled).

from_date: Option<String>

Orders created on or after this date (RFC 3339, e.g. 2024-01-15T00:00:00Z).

to_date: Option<String>

Orders created on or before this date (RFC 3339, e.g. 2024-12-31T23:59:59Z).

Implementations

impl OrderFilterParams

pub fn resolved_limit(&self) -> u32

Resolved limit with bounds checking.

pub fn resolved_offset(&self) -> u32

Resolved offset.

Trait Implementations

impl Clone for OrderFilterParams

fn clone(&self) -> OrderFilterParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderFilterParams

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

Formats the value using the given formatter.

impl Default for OrderFilterParams

fn default() -> OrderFilterParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderFilterParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for OrderFilterParams

fn into_params( parameter_in_provider: impl Fn() -> Option<ParameterIn>, ) -> Vec<Parameter>

Provide Vec of openapi::path::Parameters to caller. The result is used in utoipa-gen library to provide OpenAPI parameter information for the endpoint using the parameters.