Object Index / Definition

You are viewing an old version of the API
OrderFulfillment

Contains details on how to fulfill this order.

Properties

Name Description
uid
string

Beta

Unique ID that identifies the fulfillment only within this order.

Max Length 60
type
string

The type of the fulfillment. See OrderFulfillmentType for possible values

state
string

The state of the fulfillment. See OrderFulfillmentState for possible values

metadata
object

Beta

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 (personally identifiable information, card details, etc.).

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

Values have a max length of 255 characters.

An application may 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.

See Metadata for more information.

pickup_details
OrderFulfillmentPickupDetails

Contains details for a pickup fulfillment. Required when fulfillment type is PICKUP.

shipment_details
OrderFulfillmentShipmentDetails

Beta

Contains details for a shipment fulfillment. Required when 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.

Share Feedback

Thanks for visiting the Square API documentation. What's on your mind?