Struct OrderFulfillmentDeliveryDetails

pub struct OrderFulfillmentDeliveryDetails {

    pub recipient: Option<OrderFulfillmentRecipient>,
    pub schedule_type: Option<OrderFulfillmentDeliveryDetailsScheduleType>,
    pub placed_at: Option<DateTime>,
    pub deliver_at: Option<DateTime>,
    pub prep_time_duration: Option<DateTime>,
    pub delivery_window_duration: Option<DateTime>,
    pub note: Option<String>,
    pub completed_at: Option<DateTime>,
    pub in_progress_at: Option<DateTime>,
    pub rejected_at: Option<DateTime>,
    pub ready_at: Option<DateTime>,
    pub delivered_at: Option<DateTime>,
    pub canceled_at: Option<DateTime>,
    pub cancel_reason: Option<String>,
    pub courier_pickup_at: Option<DateTime>,
    pub courier_pickup_window_duration: Option<DateTime>,
    pub is_no_contact_delivery: Option<bool>,
    pub dropoff_notes: Option<String>,
    pub courier_provider_name: Option<String>,
    pub courier_support_phone_number: Option<String>,
    pub square_delivery_id: Option<String>,
    pub external_delivery_id: Option<String>,
    pub managed_delivery: Option<bool>,
}

Describes delivery details of an order fulfillment.

Fields

recipient: Option<OrderFulfillmentRecipient>

Information about the person meant to receive this shipment fulfillment.

schedule_type: Option<OrderFulfillmentDeliveryDetailsScheduleType>

Indicates the fulfillment delivery schedule type. If SCHEDULED, then deliver_at is required. If ASAP, then prep_time_duration is required. The default is SCHEDULED

placed_at: Option<DateTime>

Read only The timestamp indicating when the shipment was requested.

deliver_at: Option<DateTime>

Read only The timestamp indicating when fulfillment is supposed to be delivered. Required When the schedule_type is ASAP

prep_time_duration: Option<DateTime>

Read only The timestamp indicating what is the duration of time it takes to prepare and deliver this fulfillment

delivery_window_duration: Option<DateTime>

The timestamp indicating the time period after the deliver_at timestamp in which to deliver the order.

note: Option<String>

Provides additional instructions about the delivery fulfillment. It is displayed in the Square Point of Sale application and set by the API.

completed_at: Option<DateTime>

Read only The timestamp indicating when this fulfillment was moved to the COMPLETED state, which indicates that the fulfillment has been completed by the seller.

in_progress_at: Option<DateTime>

Read only The timestamp indicating when this fulfillment was moved to the RESERVED state, which indicates that the fulfillment has been started by the seller.

rejected_at: Option<DateTime>

Read only The timestamp indicating when this fulfillment was moved to the FAILED state, which indicates that the fulfillment has been rejected.

ready_at: Option<DateTime>

Read only The timestamp indicating when this fulfillment was moved to the PREPARED state, which indicates that the fulfillment has been marked by the seller as ready to be picked up.

delivered_at: Option<DateTime>

Read only The timestamp indicating when this fulfillment has been delivered

canceled_at: Option<DateTime>

The timestamp indicating the shipment was canceled.

cancel_reason: Option<String>

A description of why the shipment was canceled.

courier_pickup_at: Option<DateTime>

Read only The timestamp indicating when an order can be picked up by the courier for delivery

courier_pickup_window_duration: Option<DateTime>

Read only The timestamp indicating the period of time in which the order should be picked up by the courier after the courier_pickup_at

is_no_contact_delivery: Option<bool>

A description of why the shipment failed to be completed.

dropoff_notes: Option<String>

A note to provide additional instructions about how to deliver the order.

courier_provider_name: Option<String>

The name of the courier provider

courier_support_phone_number: Option<String>

The support phone number of the courier.

square_delivery_id: Option<String>

The identifier for the delivery created by Square.

external_delivery_id: Option<String>

The identifier for the delivery created by the third-party courier service.

managed_delivery: Option<bool>

The flag to indicate the delivery is managed by a third party (ie DoorDash), which means we may not receive all recipient information for PII purposes.

Trait Implementations

impl Clone for OrderFulfillmentDeliveryDetails

fn clone(&self) -> OrderFulfillmentDeliveryDetails

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderFulfillmentDeliveryDetails

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

Formats the value using the given formatter.

impl Default for OrderFulfillmentDeliveryDetails

fn default() -> OrderFulfillmentDeliveryDetails

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderFulfillmentDeliveryDetails

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderFulfillmentDeliveryDetails

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

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 OrderFulfillmentDeliveryDetails

impl StructuralPartialEq for OrderFulfillmentDeliveryDetails