Object Index
You are viewing an old version of the API
CatalogItemVariation
Object Index
An item variation, representing a product for sale, in the Catalog object model.
Each item must have at least one item variation and can have at most 250 item variations.
An item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked
number of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both
stockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass
variation is sellable, but not stockable. To accurately keep track of the wine's inventory count at any time, the sellable count must be
converted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes
the stockable_conversion
property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count
decreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.
Properties
Name | Description |
---|---|
item_
|
The ID of the |
name
|
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. |
sku
|
The item variation's SKU, if any. This is a searchable attribute for use in applicable query filters. |
upc
|
The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters. The value of this attribute should be a number of 12-14 digits long. This restriction is enforced on the Square Seller Dashboard, Square Point of Sale or Retail Point of Sale apps, where this attribute shows in the GTIN field. If a non-compliant UPC value is assigned to this attribute using the API, the value is not editable on the Seller Dashboard, Square Point of Sale or Retail Point of Sale apps unless it is updated to fit the expected format. |
ordinal
|
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 |
pricing_
|
Indicates whether the item variation's price is fixed or determined at the time of sale. |
price_
|
The item variation's price, if fixed pricing is used. |
location_
|
Per-location price and inventory overrides. |
track_
|
If |
inventory_
|
Indicates whether the item variation displays an alert when its inventory quantity is less than or equal
to its |
inventory_
|
If the inventory quantity for the variation is less than or equal to this value and This value is always an integer. |
user_
|
Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points. |
service_
|
If the |
available_
Beta
|
If the |
item_
Beta
|
List of item option values associated with this item variation. Listed in the same order as the item options of the parent item. |
measurement_
|
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. |
sellable
Beta
|
Whether this variation can be sold. The inventory count of a sellable variation indicates the number of units available for sale. When a variation is both stockable and sellable, its sellable inventory count can be smaller than or equal to its stockable count. |
stockable
Beta
|
Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE). When a variation is both stockable and sellable, the inventory count of a stockable variation keeps track of the number of units of this variation in stock and is not an indicator of the number of units of the variation that can be sold. |
image_
Beta
|
The IDs of images associated with this |
team_
Beta
|
Tokens of employees that can perform the service represented by this variation. Only valid for
variations of type |
stockable_
Beta
|
The unit conversion rule, as prescribed by the CatalogStockConversion type, that describes how this non-stockable (i.e., sellable/receivable) item variation is converted to/from the stockable item variation sharing the same parent item. With the stock conversion, you can accurately track inventory when an item variation is sold in one unit, but stocked in another unit. |