CatalogItemVariation (Square 20.0.0.20220512 API)

java.lang.Object
- com.squareup.square.models.CatalogItemVariation

```
public class CatalogItemVariation
extends Object
```
This is a model class for CatalogItemVariation type.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CatalogItemVariation.Builder
Class to build instances of CatalogItemVariation.

Nested Classes
Modifier and Type	Class and Description
`static class`	`CatalogItemVariation.Builder` Class to build instances of `CatalogItemVariation`.

Constructor Summary

Constructors
Constructor and Description
CatalogItemVariation(String itemId, String name, String sku, String upc, Integer ordinal, String pricingType, Money priceMoney, List<ItemVariationLocationOverrides> locationOverrides, Boolean trackInventory, String inventoryAlertType, Long inventoryAlertThreshold, String userData, Long serviceDuration, Boolean availableForBooking, List<CatalogItemOptionValueForItemVariation> itemOptionValues, String measurementUnitId, Boolean sellable, Boolean stockable, List<String> imageIds, List<String> teamMemberIds, CatalogStockConversion stockableConversion) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Boolean`	`getAvailableForBooking()` Getter for AvailableForBooking.
`List<String>`	`getImageIds()` Getter for ImageIds.
`Long`	`getInventoryAlertThreshold()` Getter for InventoryAlertThreshold.
`String`	`getInventoryAlertType()` Getter for InventoryAlertType.
`String`	`getItemId()` Getter for ItemId.
`List<CatalogItemOptionValueForItemVariation>`	`getItemOptionValues()` Getter for ItemOptionValues.
`List<ItemVariationLocationOverrides>`	`getLocationOverrides()` Getter for LocationOverrides.
`String`	`getMeasurementUnitId()` Getter for MeasurementUnitId.
`String`	`getName()` Getter for Name.
`Integer`	`getOrdinal()` Getter for Ordinal.
`Money`	`getPriceMoney()` Getter for PriceMoney.
`String`	`getPricingType()` Getter for PricingType.
`Boolean`	`getSellable()` Getter for Sellable.
`Long`	`getServiceDuration()` Getter for ServiceDuration.
`String`	`getSku()` Getter for Sku.
`Boolean`	`getStockable()` Getter for Stockable.
`CatalogStockConversion`	`getStockableConversion()` Getter for StockableConversion.
`List<String>`	`getTeamMemberIds()` Getter for TeamMemberIds.
`Boolean`	`getTrackInventory()` Getter for TrackInventory.
`String`	`getUpc()` Getter for Upc.
`String`	`getUserData()` Getter for UserData.
`int`	`hashCode()`
`CatalogItemVariation.Builder`	`toBuilder()` Builds a new `CatalogItemVariation.Builder` object.
`String`	`toString()` Converts this CatalogItemVariation into string format.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CatalogItemVariation
```
public CatalogItemVariation(String itemId,
                            String name,
                            String sku,
                            String upc,
                            Integer ordinal,
                            String pricingType,
                            Money priceMoney,
                            List<ItemVariationLocationOverrides> locationOverrides,
                            Boolean trackInventory,
                            String inventoryAlertType,
                            Long inventoryAlertThreshold,
                            String userData,
                            Long serviceDuration,
                            Boolean availableForBooking,
                            List<CatalogItemOptionValueForItemVariation> itemOptionValues,
                            String measurementUnitId,
                            Boolean sellable,
                            Boolean stockable,
                            List<String> imageIds,
                            List<String> teamMemberIds,
                            CatalogStockConversion stockableConversion)
```
    Initialization constructor.
    
    Parameters:
    
    itemId - String value for itemId.
    
    name - String value for name.
    
    sku - String value for sku.
    
    upc - String value for upc.
    
    ordinal - Integer value for ordinal.
    
    pricingType - String value for pricingType.
    
    priceMoney - Money value for priceMoney.
    
    locationOverrides - List of ItemVariationLocationOverrides value for locationOverrides.
    
    trackInventory - Boolean value for trackInventory.
    
    inventoryAlertType - String value for inventoryAlertType.
    
    inventoryAlertThreshold - Long value for inventoryAlertThreshold.
    
    userData - String value for userData.
    
    serviceDuration - Long value for serviceDuration.
    
    availableForBooking - Boolean value for availableForBooking.
    
    itemOptionValues - List of CatalogItemOptionValueForItemVariation value for itemOptionValues.
    
    measurementUnitId - String value for measurementUnitId.
    
    sellable - Boolean value for sellable.
    
    stockable - Boolean value for stockable.
    
    imageIds - List of String value for imageIds.
    
    teamMemberIds - List of String value for teamMemberIds.
    
    stockableConversion - CatalogStockConversion value for stockableConversion.
- Method Detail
  - getItemId
```
public String getItemId()
```
    Getter for ItemId. The ID of the `CatalogItem` associated with this item variation.
    
    Returns:
    
    Returns the String
  - getName
```
public String getName()
```
    Getter for 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.
    
    Returns:
    
    Returns the String
  - getSku
```
public String getSku()
```
    Getter for Sku. The item variation's SKU, if any. This is a searchable attribute for use in applicable query filters.
    
    Returns:
    
    Returns the String
  - getUpc
```
public String getUpc()
```
    Getter for 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.
    
    Returns:
    
    Returns the String
  - getOrdinal
```
public Integer getOrdinal()
```
    Getter for Ordinal. 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.
    
    Returns:
    
    Returns the Integer
  - getPricingType
```
public String getPricingType()
```
    Getter for PricingType. Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.
    
    Returns:
    
    Returns the String
  - getPriceMoney
```
public Money getPriceMoney()
```
    Getter for PriceMoney. Represents an amount of money. `Money` fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered unsigned and can only hold positive amounts. For signed fields, the sign of the value indicates the purpose of the money transfer. See [Working with Monetary Amounts](https://developer.squareup.com/docs/build-basics/working-with-monetary-amounts) for more information.
    
    Returns:
    
    Returns the Money
  - getLocationOverrides
```
public List<ItemVariationLocationOverrides> getLocationOverrides()
```
    Getter for LocationOverrides. Per-location price and inventory overrides.
    
    Returns:
    
    Returns the List of ItemVariationLocationOverrides
  - getTrackInventory
```
public Boolean getTrackInventory()
```
    Getter for TrackInventory. If `true`, inventory tracking is active for the variation.
    
    Returns:
    
    Returns the Boolean
  - getInventoryAlertType
```
public String getInventoryAlertType()
```
    Getter for InventoryAlertType. Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.
    
    Returns:
    
    Returns the String
  - getInventoryAlertThreshold
```
public Long getInventoryAlertThreshold()
```
    Getter for InventoryAlertThreshold. 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.
    
    Returns:
    
    Returns the Long
  - getUserData
```
public String getUserData()
```
    Getter for UserData. Arbitrary user metadata to associate with the item variation. This attribute value length is of Unicode code points.
    
    Returns:
    
    Returns the String
  - getServiceDuration
```
public Long getServiceDuration()
```
    Getter for ServiceDuration. 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).
    
    Returns:
    
    Returns the Long
  - getAvailableForBooking
```
public Boolean getAvailableForBooking()
```
    Getter for AvailableForBooking. If the `CatalogItem` that owns this item variation is of type `APPOINTMENTS_SERVICE`, a bool representing whether this service is available for booking.
    
    Returns:
    
    Returns the Boolean
  - getItemOptionValues
```
public List<CatalogItemOptionValueForItemVariation> getItemOptionValues()
```
    Getter for ItemOptionValues. List of item option values associated with this item variation. Listed in the same order as the item options of the parent item.
    
    Returns:
    
    Returns the List of CatalogItemOptionValueForItemVariation
  - getMeasurementUnitId
```
public String getMeasurementUnitId()
```
    Getter for MeasurementUnitId. 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.
    
    Returns:
    
    Returns the String
  - getSellable
```
public Boolean getSellable()
```
    Getter for Sellable. 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 stocable count.
    
    Returns:
    
    Returns the Boolean
  - getStockable
```
public Boolean getStockable()
```
    Getter for Stockable. Whether stock is counted directly on this variation (TRUE) or only on its components (FALSE). 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.
    
    Returns:
    
    Returns the Boolean
  - getImageIds
```
public List<String> getImageIds()
```
    Getter for ImageIds. The IDs of images associated with this `CatalogItemVariation` instance. These images will be shown to customers in Square Online Store.
    
    Returns:
    
    Returns the List of String
  - getTeamMemberIds
```
public List<String> getTeamMemberIds()
```
    Getter for TeamMemberIds. Tokens of employees that can perform the service represented by this variation. Only valid for variations of type `APPOINTMENTS_SERVICE`.
    
    Returns:
    
    Returns the List of String
  - getStockableConversion
```
public CatalogStockConversion getStockableConversion()
```
    Getter for StockableConversion. Represents the rule of conversion between a stockable [CatalogItemVariation]($m/CatalogItemVariation) and a non-stockable sell-by or receive-by `CatalogItemVariation` that share the same underlying stock.
    
    Returns:
    
    Returns the CatalogStockConversion
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Converts this CatalogItemVariation into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public CatalogItemVariation.Builder toBuilder()
```
    Builds a new CatalogItemVariation.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new CatalogItemVariation.Builder object

Class CatalogItemVariation

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CatalogItemVariation

Method Detail

getItemId

getName

getSku

getUpc

getOrdinal

getPricingType

getPriceMoney

getLocationOverrides

getTrackInventory

getInventoryAlertType

getInventoryAlertThreshold

getUserData

getServiceDuration

getAvailableForBooking

getItemOptionValues

getMeasurementUnitId

getSellable

getStockable

getImageIds

getTeamMemberIds

getStockableConversion

hashCode

equals

toString

toBuilder