An item variation (i.e., product) in the Catalog object model.
<- Object
Object
An item variation (i.e., product) in the Catalog object model.
Each item may have a maximum of 250 item variations.
The item variation's name. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.
The item variation's SKU, if any. This is a searchable attribute for use in applicable query filters.
The item variation's UPC, if any. This is a searchable attribute for use in applicable query filters. It is only accessible through the Square API, and not exposed in the Square Seller Dashboard, Square Point of Sale or Retail Point of Sale apps.
Read only The order in which this item variation should be displayed. This value is read-only. On writes, the ordinal for each item variation within a parent CatalogItem is set according to the item variations's position. On reads, the value is not guaranteed to be sequential or unique.
Indicates whether the item variation's price is fixed or determined at the time of sale.
Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold.
If the inventory quantity for the variation is less than or equal to this value and inventory_alert_type is LOW_QUANTITY, the variation displays an alert in the merchant dashboard.
This value is always an integer.
Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points.
If the CatalogItem that owns this item variation is of type APPOINTMENTS_SERVICE, then this is the duration of the service in milliseconds. For example, a 30 minute appointment would have the value 1800000, which is equal to 30 (minutes) * 60 (seconds per minute) * 1000 (milliseconds per second).
List of item option values associated with this item variation. Listed in the same order as the item options of the parent item.