SquareConnect::CatalogItemVariation

Description

An item variation (i.e., product) in the Catalog object model. Each item may have a maximum of 250 item variations.

Properties

Name	Type	Description	Notes
item_id	String	The ID of the CatalogItem associated with this item variation. Searchable.	[optional]
name	String	The item variation's name. Searchable. This field has max length of 255 Unicode code points.	[optional]
sku	String	The item variation's SKU, if any. Searchable.	[optional]
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.	[optional]
ordinal	Integer	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.	[optional]
pricing_type	String	Indicates whether the item variation's price is fixed or determined at the time of sale. See CatalogPricingType for possible values	[optional]
price_money	Money	The item variation's price, if fixed pricing is used.	[optional]
location_overrides	Array<ItemVariationLocationOverrides>	Per-location price and inventory overrides.	[optional]
track_inventory	BOOLEAN	If `true`, inventory tracking is active for the variation.	[optional]
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`. See InventoryAlertType for possible values	[optional]
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.	[optional]
user_data	String	Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable.	[optional]
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).	[optional]
item_option_values	Array<CatalogItemOptionValueForItemVariation>	List of item option values associated with this item variation. Listed in the same order as the item options of the parent item.	[optional]
measurement_unit_id	String	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.	[optional]