Object Index
You are viewing an old version of the API
Fulfillment
Object Index
Contains details about how to fulfill this order.
Orders can only be created with at most one fulfillment using the API. However, orders returned by the Orders API might contain multiple fulfillments because sellers can create multiple fulfillments using Square products such as Square Online.
Properties
Name | Description |
---|---|
uid
Beta
|
A unique ID that identifies the fulfillment only within this order. |
type
|
The type of the fulfillment. |
state
|
The state of the fulfillment. |
line_
Beta
|
Read only Describes what order line items this fulfillment applies to.
It can be |
entries
Beta
|
Read only A list of entries pertaining to the fulfillment of an order. Each entry must reference
a valid Multiple entries can reference the same line item An order cannot be marked as |
metadata
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 (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
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_
|
Contains details for a pickup fulfillment. These details are required when the fulfillment
type is |
shipment_
Beta
|
Contains details for a shipment fulfillment. These details are required when the fulfillment type
is A shipment fulfillment's relationship to fulfillment |
delivery_
Beta
|
|