Object Index
You are viewing an old version of the API
OrderLineItemModifier
Object Index
Properties
Name | Description |
---|---|
uid
Beta
|
A unique ID that identifies the modifier only within this order. |
catalog_
|
The catalog object ID referencing CatalogModifier. |
catalog_
|
The version of the catalog object that this modifier references. |
name
|
The name of the item modifier. |
quantity
|
The quantity of the line item modifier. The modifier quantity can be 0 or more.
For example, suppose a restaurant offers a cheeseburger on the menu. When a buyer orders
this item, the restaurant records the purchase by creating an |
base_
|
The base price for the modifier.
|
total_
|
Read only The total price of the item modifier for its line item.
This is the modifier's |
metadata
Beta
|
Application-defined data attached to this order. 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. |