Struct OrderFulfillment

pub struct OrderFulfillment {
    pub uid: Option<String>,
    pub type: Option<OrderFulfillmentType>,
    pub state: Option<OrderFulfillmentState>,
    pub line_item_application: Option<OrderFulfillmentFulfillmentLineItemApplication>,
    pub entries: Option<Vec<OrderFulfillmentFulfillmentEntry>>,
    pub metadata: Option<HashMap<String, String>>,
    pub pickup_details: Option<OrderFulfillmentPickupDetails>,
    pub shipment_details: Option<OrderFulfillmentShipmentDetails>,
    pub delivery_details: Option<OrderFulfillmentDeliveryDetails>,
}

This is a model struct for OrderFulfillment type.

Contains details about how to fulfill this order.

Fields

uid: Option<String>

A unique ID that identifies the fulfillment only within this order.

type: Option<OrderFulfillmentType>

The type of the fulfillment.

state: Option<OrderFulfillmentState>

The state of the fulfillment.

line_item_application: Option<OrderFulfillmentFulfillmentLineItemApplication>

Describes what order line items this fulfillment applies to. It can be ALL or ENTRY_LIST with a supplied list of fulfillment entries.

entries: Option<Vec<OrderFulfillmentFulfillmentEntry>>

A list of entries pertaining to the fulfillment of an order. Each entry must reference a valid uid for an order line item in the line_item_uid field, as well as a quantity to fulfill.

Multiple entries can reference the same line item uid, as long as the total quantity among all fulfillment entries referencing a single line item does not exceed the quantity of the order’s line item itself.

An order cannot be marked as COMPLETED before all fulfillments are COMPLETED, CANCELED, or FAILED. Fulfillments can be created and completed independently before order completion.

metadata: Option<HashMap<String, String>>

Application-defined data attached to this fulfillment. Metadata fields are intended to store descriptive references or associations with an entity in another system or store brief information about the object. Square does not process this field; it only stores and returns it in relevant API calls. Do not use metadata to store any sensitive information (such as personally identifiable information or card details).

Keys written by applications must be 60 characters or less and must be in the character set [a-zA-Z0-9_-]. Entries can also include metadata generated by Square. These keys are prefixed with a namespace, separated from the key with a ‘:’ character.

Values have a maximum length of 255 characters.

An application can have up to 10 entries per metadata field.

Entries written by applications are private and can only be read or modified by the same application.

For more information, see Metadata.

pickup_details: Option<OrderFulfillmentPickupDetails>

Contains details for a pickup fulfillment. These details are required when the fulfillment type is PICKUP.

shipment_details: Option<OrderFulfillmentShipmentDetails>

Contains details for a shipment fulfillment. These details are required when the fulfillment type is SHIPMENT.

A shipment fulfillment’s relationship to fulfillment state: PROPOSED: A shipment is requested. RESERVED: Fulfillment accepted. Shipment processing. PREPARED: Shipment packaged. Shipping label created. COMPLETED: Package has been shipped. CANCELED: Shipment has been canceled. FAILED: Shipment has failed.

delivery_details: Option<OrderFulfillmentDeliveryDetails>

Describes delivery details of an order fulfillment. These details are required when the fulfillment type is Delivery.

Trait Implementations

impl Clone for OrderFulfillment

fn clone(&self) -> OrderFulfillment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderFulfillment

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

Formats the value using the given formatter.

impl Default for OrderFulfillment

fn default() -> OrderFulfillment

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OrderFulfillment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for OrderFulfillment

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

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 OrderFulfillment

impl StructuralPartialEq for OrderFulfillment