V1Variation

November 20, 2019 ยท View on GitHub

Description

V1Variation Note: This model is deprecated.

Properties

NameGetterSetterTypeDescriptionNotes
idgetId()setId($value)stringThe item variation's unique ID.[optional]
namegetName()setName($value)stringThe item variation's name.[optional]
item_idgetItemId()setItemId($value)stringThe ID of the variation's associated item.[optional]
ordinalgetOrdinal()setOrdinal($value)intIndicates the variation's list position when displayed in Square Point of Sale 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_typegetPricingType()setPricingType($value)stringIndicates whether the item variation's price is fixed or determined at the time of sale. See V1VariationPricingType for possible values[optional]
price_moneygetPriceMoney()setPriceMoney($value)\SquareConnect\Model\V1MoneyThe item variation's price, if any.[optional]
skugetSku()setSku($value)stringThe item variation's SKU, if any.[optional]
track_inventorygetTrackInventory()setTrackInventory($value)boolIf true, inventory tracking is active for the variation.[optional]
inventory_alert_typegetInventoryAlertType()setInventoryAlertType($value)stringIndicates 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_thresholdgetInventoryAlertThreshold()setInventoryAlertThreshold($value)intIf 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_datagetUserData()setUserData($value)stringArbitrary metadata associated with the variation. Cannot exceed 255 characters.[optional]
v2_idgetV2Id()setV2Id($value)stringThe ID of the CatalogObject in the Connect v2 API. Objects that are shared across multiple locations share the same v2 ID.[optional]

Note: All properties are protected and only accessed via getters and setters.

[Back to Model list] [Back to API list] [Back to README]