Struct OrderFulfillmentPickupDetails

pub struct OrderFulfillmentPickupDetails {

    pub recipient: Option<OrderFulfillmentRecipient>,
    pub expires_at: Option<DateTime>,
    pub auto_complete_duration: Option<String>,
    pub schedule_type: Option<OrderFulfillmentPickupDetailsScheduleType>,
    pub pickup_at: Option<DateTime>,
    pub pickup_window_duration: Option<String>,
    pub prep_time_duration: Option<String>,
    pub note: Option<String>,
    pub placed_at: Option<DateTime>,
    pub accepted_at: Option<DateTime>,
    pub rejected_at: Option<DateTime>,
    pub ready_at: Option<DateTime>,
    pub expired_at: Option<DateTime>,
    pub picked_up_at: Option<DateTime>,
    pub canceled_at: Option<DateTime>,
    pub cancel_reason: Option<String>,
    pub is_curbside_pickup: Option<bool>,
    pub curbside_pickup_details: Option<OrderFulfillmentPickupDetailsCurbsidePickupDetails>,
}

This is a model struct for OrderFulfillmentPickupDetails type.

Contains details necessary to fulfill a pickup order.

Fields

recipient: Option<OrderFulfillmentRecipient>

Information about the person meant to pick up this fulfillment from a physical location.

expires_at: Option<DateTime>

The timestamp indicating when this fulfillment expires if it is not accepted. The expiration time can only be set up to 7 days in the future. If expires_at is not set, this pickup fulfillment is automatically accepted when placed.

auto_complete_duration: Option<String>

The duration of time after which an open and accepted pickup fulfillment is automatically moved to the COMPLETED state. The duration must be in RFC 3339 format (for example, “P1W3D”).

If not set, this pickup fulfillment remains accepted until it is canceled or completed.

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

schedule_type: Option<OrderFulfillmentPickupDetailsScheduleType>

The schedule type of the pickup fulfillment. Defaults to SCHEDULED.

pickup_at: Option<DateTime>

The timestamp that represents the start of the pickup window.

For fulfillments with the schedule type ASAP, this is automatically set to the current time plus the expected duration to prepare the fulfillment.

pickup_window_duration: Option<String>

The window of time in which the order should be picked up after the pickup_at timestamp. Must be in RFC 3339 duration format, e.g., “P1W3D”. Can be used as an informational guideline for merchants.

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

prep_time_duration: Option<String>

The duration of time it takes to prepare this fulfillment. The duration must be in RFC 3339 format (for example, “P1W3D”).

Example for 2 days, 12 hours, 30 minutes, and 15 seconds: P2DT12H30M15S

note: Option<String>

A note meant to provide additional instructions about the pickup fulfillment displayed in the Square Point of Sale application and set by the API.

placed_at: Option<DateTime>

Read only The timestamp indicating when the fulfillment was placed.

accepted_at: Option<DateTime>

Read only The timestamp indicating when the fulfillment was accepted.

rejected_at: Option<DateTime>

Read only The timestamp indicating when the fulfillment was rejected.

ready_at: Option<DateTime>

Read only The timestamp indicating when the fulfillment is marked ready for pickup.

expired_at: Option<DateTime>

Read only The timestamp indicating when the fulfillment expired.

picked_up_at: Option<DateTime>

Read only The timestamp indicating when the fulfillment was picked up by the recipient.

canceled_at: Option<DateTime>

Read only The timestamp indicating when the fulfillment was canceled.

cancel_reason: Option<String>

A description of why the pickup was canceled. The maximum length: 100 characters.

is_curbside_pickup: Option<bool>

If set to true, indicates that this pickup order is for curbside pickup, not in-store pickup.

curbside_pickup_details: Option<OrderFulfillmentPickupDetailsCurbsidePickupDetails>

Specific details for curbside pickup. These details can only be populated if is_curbside_pickup is set to true.

Trait Implementations

impl Clone for OrderFulfillmentPickupDetails

fn clone(&self) -> OrderFulfillmentPickupDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderFulfillmentPickupDetails

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

Formats the value using the given formatter.

impl Default for OrderFulfillmentPickupDetails

fn default() -> OrderFulfillmentPickupDetails

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderFulfillmentPickupDetails

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderFulfillmentPickupDetails

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

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 OrderFulfillmentPickupDetails

impl StructuralPartialEq for OrderFulfillmentPickupDetails