Object Index / Definition

You are viewing an old version of the API
Catalog​Item​Variation

An item variation (i.e., product) in the Catalog object model

Each item may have a maximum of 250 item variations.

Properties

Name Description
inventory_alert_threshold
integer

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.

inventory_alert_type
string

Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold.

item_id
string

The ID of the CatalogItem associated with this item variation. Searchable.

item_option_values
Catalog​Item​Option​Value​For​Item​Variation [ ]

Beta

List of item option values associated with this item variation. Listed in the same order as the item options of the parent item.

location_overrides
Item​Variation​Location​Overrides [ ]

Per-location price and inventory overrides.

measurement_unit_id
string

Beta

ID of the ‘CatalogMeasurementUnit’ that is used to measure the quantity sold of this item variation. If left unset, the item will be sold in whole quantities.

name
string

The item variation's name. Searchable. This field has max length of 255 Unicode code points.

ordinal
integer

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.

price_money
Money

The item variation's price, if fixed pricing is used.

pricing_type
string

Indicates whether the item variation's price is fixed or determined at the time of sale.

service_duration
integer

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).

sku
string

The item variation's SKU, if any. Searchable.

track_inventory
boolean

If true, inventory tracking is active for the variation.

upc
string

The item variation's UPC, if any. Searchable in the Connect API. This field is only exposed in the Connect API. It is not exposed in Square's Dashboard, Square Point of Sale app or Retail Point of Sale app.

user_data
string

Arbitrary user metadata to associate with the item variation. Searchable. This field has max length of 255 Unicode code points.

Share Feedback

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