Skip to content

Latest commit

 

History

History
23 lines (19 loc) · 3.59 KB

CatalogItemVariation.md

File metadata and controls

23 lines (19 loc) · 3.59 KB

CatalogItemVariation

Properties

Name Getter Setter Type Description Notes
item_id getItemId() setItemId($value) string The ID of the CatalogItem associated with this item variation. Searchable. [optional]
name getName() setName($value) string The item variation's name. Searchable. [optional]
sku getSku() setSku($value) string The item variation's SKU, if any. Searchable. [optional]
upc getUpc() setUpc($value) 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 getOrdinal() setOrdinal($value) int 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 getPricingType() setPricingType($value) string Indicates whether the item variation's price is fixed or determined at the time of sale. See CatalogPricingType for all possible values. [optional]
price_money getPriceMoney() setPriceMoney($value) \SquareConnect\Model\Money The item variation's price, if fixed pricing is used. [optional]
location_overrides getLocationOverrides() setLocationOverrides($value) \SquareConnect\Model\ItemVariationLocationOverrides[] Per-location price and inventory overrides. [optional]
track_inventory getTrackInventory() setTrackInventory($value) bool If `true`, inventory tracking is active for the variation. [optional]
inventory_alert_type getInventoryAlertType() setInventoryAlertType($value) 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 all possible values. [optional]
inventory_alert_threshold getInventoryAlertThreshold() setInventoryAlertThreshold($value) int 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 getUserData() setUserData($value) string Arbitrary user metadata to associate with the item variation. Cannot exceed 255 characters. Searchable. [optional]
service_duration getServiceDuration() setServiceDuration($value) int 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]

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

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