Struct SearchOrdersDateTimeFilter

pub struct SearchOrdersDateTimeFilter {
    pub created_at: Option<TimeRange>,
    pub updated_at: Option<TimeRange>,
    pub closed_at: Option<TimeRange>,
}

Filter for Order objects based on whether their CREATED_AT, CLOSED_AT, or UPDATED_AT timestamps fall within a specified time range.

You can specify the time range and which timestamp to filter for. You can filter for only one time range at a time.

For each time range, the start time and end time are inclusive. If the end time is absent, it defaults to the time of the first request for the cursor.

Important: If you use the DateTimeFilter in a SearchOrders query, you must set the sort_field in OrdersSort to the same field you filter for. For example, if you set the CLOSED_AT field in DateTimeFilter, you must set the sort_field in SearchOrdersSort to CLOSED_AT. Otherwise, SearchOrders throws an error. Learn more about filtering orders by time range.

Fields

created_at: Option<TimeRange>

The time range for filtering on the created_at timestamp. If you use this value, you must set the sort_field in the OrdersSearchSort object to CREATED_AT.

updated_at: Option<TimeRange>

The time range for filtering on the updated_at timestamp. If you use this value, you must set the sort_field in the OrdersSearchSort object to UPDATED_AT.

closed_at: Option<TimeRange>

The time range for filtering on the closed_at timestamp. If you use this value, you must set the sort_field in the OrdersSearchSort object to CLOSED_AT.

Trait Implementations

impl Clone for SearchOrdersDateTimeFilter

fn clone(&self) -> SearchOrdersDateTimeFilter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SearchOrdersDateTimeFilter

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

Formats the value using the given formatter.

impl Default for SearchOrdersDateTimeFilter

fn default() -> SearchOrdersDateTimeFilter

Returns the “default value” for a type.

impl PartialEq for SearchOrdersDateTimeFilter

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for SearchOrdersDateTimeFilter

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 SearchOrdersDateTimeFilter

impl StructuralPartialEq for SearchOrdersDateTimeFilter