CatalogItem (Square 20.0.0.20220512 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
`CatalogItem(String name, String description, String abbreviation, String labelColor, Boolean availableOnline, Boolean availableForPickup, Boolean availableElectronically, String categoryId, List<String> taxIds, List<CatalogItemModifierListInfo> modifierListInfo, List<CatalogObject> variations, String productType, Boolean skipModifierScreen, List<CatalogItemOptionForItem> itemOptions, List<String> imageIds, String sortName)` Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAbbreviation()` Getter for Abbreviation.
`Boolean`	`getAvailableElectronically()` Getter for AvailableElectronically.
`Boolean`	`getAvailableForPickup()` Getter for AvailableForPickup.
`Boolean`	`getAvailableOnline()` Getter for AvailableOnline.
`String`	`getCategoryId()` Getter for CategoryId.
`String`	`getDescription()` Getter for Description.
`List<String>`	`getImageIds()` Getter for ImageIds.
`List<CatalogItemOptionForItem>`	`getItemOptions()` Getter for ItemOptions.
`String`	`getLabelColor()` Getter for LabelColor.
`List<CatalogItemModifierListInfo>`	`getModifierListInfo()` Getter for ModifierListInfo.
`String`	`getName()` Getter for Name.
`String`	`getProductType()` Getter for ProductType.
`Boolean`	`getSkipModifierScreen()` Getter for SkipModifierScreen.
`String`	`getSortName()` Getter for SortName.
`List<String>`	`getTaxIds()` Getter for TaxIds.
`List<CatalogObject>`	`getVariations()` Getter for Variations.
`int`	`hashCode()`
`CatalogItem.Builder`	`toBuilder()` Builds a new `CatalogItem.Builder` object.
`String`	`toString()` Converts this CatalogItem into string format.

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

- Constructor Detail
  - CatalogItem
```
public CatalogItem(String name,
                   String description,
                   String abbreviation,
                   String labelColor,
                   Boolean availableOnline,
                   Boolean availableForPickup,
                   Boolean availableElectronically,
                   String categoryId,
                   List<String> taxIds,
                   List<CatalogItemModifierListInfo> modifierListInfo,
                   List<CatalogObject> variations,
                   String productType,
                   Boolean skipModifierScreen,
                   List<CatalogItemOptionForItem> itemOptions,
                   List<String> imageIds,
                   String sortName)
```
    Initialization constructor.
    
    Parameters:
    
    name - String value for name.
    
    description - String value for description.
    
    abbreviation - String value for abbreviation.
    
    labelColor - String value for labelColor.
    
    availableOnline - Boolean value for availableOnline.
    
    availableForPickup - Boolean value for availableForPickup.
    
    availableElectronically - Boolean value for availableElectronically.
    
    categoryId - String value for categoryId.
    
    taxIds - List of String value for taxIds.
    
    modifierListInfo - List of CatalogItemModifierListInfo value for modifierListInfo.
    
    variations - List of CatalogObject value for variations.
    
    productType - String value for productType.
    
    skipModifierScreen - Boolean value for skipModifierScreen.
    
    itemOptions - List of CatalogItemOptionForItem value for itemOptions.
    
    imageIds - List of String value for imageIds.
    
    sortName - String value for sortName.
- Method Detail
  - getName
```
public String getName()
```
    Getter for Name. The item's name. This is a searchable attribute for use in applicable query filters, its value must not be empty, and the length is of Unicode code points.
    
    Returns:
    
    Returns the String
  - getDescription
```
public String getDescription()
```
    Getter for Description. The item's description. This is a searchable attribute for use in applicable query filters, and its value length is of Unicode code points.
    
    Returns:
    
    Returns the String
  - getAbbreviation
```
public String getAbbreviation()
```
    Getter for Abbreviation. The text of the item's display label in the Square Point of Sale app. Only up to the first five characters of the string are used. This attribute is searchable, and its value length is of Unicode code points.
    
    Returns:
    
    Returns the String
  - getLabelColor
```
public String getLabelColor()
```
    Getter for LabelColor. The color of the item's display label in the Square Point of Sale app. This must be a valid hex color code.
    
    Returns:
    
    Returns the String
  - getAvailableOnline
```
public Boolean getAvailableOnline()
```
    Getter for AvailableOnline. If `true`, the item can be added to shipping orders from the merchant's online store.
    
    Returns:
    
    Returns the Boolean
  - getAvailableForPickup
```
public Boolean getAvailableForPickup()
```
    Getter for AvailableForPickup. If `true`, the item can be added to pickup orders from the merchant's online store.
    
    Returns:
    
    Returns the Boolean
  - getAvailableElectronically
```
public Boolean getAvailableElectronically()
```
    Getter for AvailableElectronically. If `true`, the item can be added to electronically fulfilled orders from the merchant's online store.
    
    Returns:
    
    Returns the Boolean
  - getCategoryId
```
public String getCategoryId()
```
    Getter for CategoryId. The ID of the item's category, if any.
    
    Returns:
    
    Returns the String
  - getTaxIds
```
public List<String> getTaxIds()
```
    Getter for TaxIds. A set of IDs indicating the taxes enabled for this item. When updating an item, any taxes listed here will be added to the item. Taxes may also be added to or deleted from an item using `UpdateItemTaxes`.
    
    Returns:
    
    Returns the List of String
  - getModifierListInfo
```
public List<CatalogItemModifierListInfo> getModifierListInfo()
```
    Getter for ModifierListInfo. A set of `CatalogItemModifierListInfo` objects representing the modifier lists that apply to this item, along with the overrides and min and max limits that are specific to this item. Modifier lists may also be added to or deleted from an item using `UpdateItemModifierLists`.
    
    Returns:
    
    Returns the List of CatalogItemModifierListInfo
  - getVariations
```
public List<CatalogObject> getVariations()
```
    Getter for Variations. A list of [CatalogItemVariation]($m/CatalogItemVariation) objects for this item. An item must have at least one variation.
    
    Returns:
    
    Returns the List of CatalogObject
  - getProductType
```
public String getProductType()
```
    Getter for ProductType. The type of a CatalogItem. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items.
    
    Returns:
    
    Returns the String
  - getSkipModifierScreen
```
public Boolean getSkipModifierScreen()
```
    Getter for SkipModifierScreen. If `false`, the Square Point of Sale app will present the `CatalogItem`'s details screen immediately, allowing the merchant to choose `CatalogModifier`s before adding the item to the cart. This is the default behavior. If `true`, the Square Point of Sale app will immediately add the item to the cart with the pre-selected modifiers, and merchants can edit modifiers by drilling down onto the item's details. Third-party clients are encouraged to implement similar behaviors.
    
    Returns:
    
    Returns the Boolean
  - getItemOptions
```
public List<CatalogItemOptionForItem> getItemOptions()
```
    Getter for ItemOptions. List of item options IDs for this item. Used to manage and group item variations in a specified order. Maximum: 6 item options.
    
    Returns:
    
    Returns the List of CatalogItemOptionForItem
  - getImageIds
```
public List<String> getImageIds()
```
    Getter for ImageIds. The IDs of images associated with this `CatalogItem` instance. These images will be shown to customers in Square Online Store. The first image will show up as the icon for this item in POS.
    
    Returns:
    
    Returns the List of String
  - getSortName
```
public String getSortName()
```
    Getter for SortName. A name to sort the item by. If this name is unspecified, namely, the `sort_name` field is absent, the regular `name` field is used for sorting. It is currently supported for sellers of the Japanese locale only.
    
    Returns:
    
    Returns the String
  - 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 CatalogItem into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public CatalogItem.Builder toBuilder()
```
    Builds a new CatalogItem.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new CatalogItem.Builder object

Class CatalogItem

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CatalogItem

Method Detail

getName

getDescription

getAbbreviation

getLabelColor

getAvailableOnline

getAvailableForPickup

getAvailableElectronically

getCategoryId

getTaxIds

getModifierListInfo

getVariations

getProductType

getSkipModifierScreen

getItemOptions

getImageIds

getSortName

hashCode

equals

toString

toBuilder