Object Index
You are viewing an old version of the API
OrderFulfillment
Object Index
Contains details on how to fulfill this order.
Properties
Name | Description |
---|---|
uid
Beta
|
Unique ID that identifies the fulfillment only within this order. |
type
|
The type of the fulfillment. |
state
|
The state of the fulfillment. |
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 (personally identifiable information, card details, etc.). Keys written by applications must be 60 characters or less and must be in the character set
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_
|
Contains details for a pickup fulfillment. Required when fulfillment
type is |
shipment_
Beta
|
Contains details for a shipment fulfillment. Required when fulfillment type
is A shipment fulfillment's relationship to fulfillment |