Struct ShipmentFilterParams 

pub struct ShipmentFilterParams {
    pub limit: Option<u32>,
    pub offset: Option<u32>,
    pub order_id: Option<String>,
    pub status: Option<String>,
    pub carrier: Option<String>,
    pub tracking_number: Option<String>,
}

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

Fields

limit: Option<u32>

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

offset: Option<u32>

Number of results to skip (default: 0).

order_id: Option<String>

Filter by order ID (UUID).

status: Option<String>

Filter by shipment status (pending, shipped, in_transit, delivered, returned, cancelled).

carrier: Option<String>

Filter by carrier (usps, ups, fedex, dhl, etc.).

tracking_number: Option<String>

Filter by tracking number.

Implementations

impl ShipmentFilterParams

pub fn resolved_limit(&self) -> u32

Resolved limit with bounds checking.

pub fn resolved_offset(&self) -> u32

Resolved offset.

Trait Implementations

impl Clone for ShipmentFilterParams

fn clone(&self) -> ShipmentFilterParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShipmentFilterParams

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

Formats the value using the given formatter.

impl Default for ShipmentFilterParams

fn default() -> ShipmentFilterParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ShipmentFilterParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl IntoParams for ShipmentFilterParams

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.