SquareConnect::V1Variation

April 10, 2019 ยท View on GitHub

Description

V1Variation

Properties

NameTypeDescriptionNotes
idStringThe item variation's unique ID.[optional]
nameStringThe item variation's name.[optional]
item_idStringThe ID of the variation's associated item.[optional]
ordinalIntegerIndicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order[optional]
pricing_typeStringIndicates whether the item variation's price is fixed or determined at the time of sale. See V1VariationPricingType for possible values[optional]
price_moneyV1MoneyThe item variation's price, if any.[optional]
skuStringThe item variation's SKU, if any.[optional]
track_inventoryBOOLEANIf true, inventory tracking is active for the variation.[optional]
inventory_alert_typeStringIndicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold. See V1VariationInventoryAlertType for possible values[optional]
inventory_alert_thresholdIntegerIf 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.[optional]
user_dataStringArbitrary metadata associated with the variation. Cannot exceed 255 characters.[optional]
v2_idStringThe ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.[optional]