CatalogItem (Square 30.0.1.20230608 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
Modifier	Constructor and Description
`protected`	CatalogItem(io.apimatic.core.types.OptionalNullable<String> name, io.apimatic.core.types.OptionalNullable<String> description, io.apimatic.core.types.OptionalNullable<String> abbreviation, io.apimatic.core.types.OptionalNullable<String> labelColor, io.apimatic.core.types.OptionalNullable<Boolean> availableOnline, io.apimatic.core.types.OptionalNullable<Boolean> availableForPickup, io.apimatic.core.types.OptionalNullable<Boolean> availableElectronically, io.apimatic.core.types.OptionalNullable<String> categoryId, io.apimatic.core.types.OptionalNullable<List<String>> taxIds, io.apimatic.core.types.OptionalNullable<List<CatalogItemModifierListInfo>> modifierListInfo, io.apimatic.core.types.OptionalNullable<List<CatalogObject>> variations, String productType, io.apimatic.core.types.OptionalNullable<Boolean> skipModifierScreen, io.apimatic.core.types.OptionalNullable<List<CatalogItemOptionForItem>> itemOptions, io.apimatic.core.types.OptionalNullable<List<String>> imageIds, io.apimatic.core.types.OptionalNullable<String> sortName, io.apimatic.core.types.OptionalNullable<String> descriptionHtml, String descriptionPlaintext) Internal initialization constructor.
	`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, String descriptionHtml, String descriptionPlaintext)` 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.
`String`	`getDescriptionHtml()` Getter for DescriptionHtml.
`String`	`getDescriptionPlaintext()` Getter for DescriptionPlaintext.
`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()`
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetAbbreviation()` Internal Getter for Abbreviation.
`protected io.apimatic.core.types.OptionalNullable<Boolean>`	`internalGetAvailableElectronically()` Internal Getter for AvailableElectronically.
`protected io.apimatic.core.types.OptionalNullable<Boolean>`	`internalGetAvailableForPickup()` Internal Getter for AvailableForPickup.
`protected io.apimatic.core.types.OptionalNullable<Boolean>`	`internalGetAvailableOnline()` Internal Getter for AvailableOnline.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetCategoryId()` Internal Getter for CategoryId.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetDescription()` Internal Getter for Description.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetDescriptionHtml()` Internal Getter for DescriptionHtml.
`protected io.apimatic.core.types.OptionalNullable<List<String>>`	`internalGetImageIds()` Internal Getter for ImageIds.
`protected io.apimatic.core.types.OptionalNullable<List<CatalogItemOptionForItem>>`	`internalGetItemOptions()` Internal Getter for ItemOptions.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetLabelColor()` Internal Getter for LabelColor.
`protected io.apimatic.core.types.OptionalNullable<List<CatalogItemModifierListInfo>>`	`internalGetModifierListInfo()` Internal Getter for ModifierListInfo.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetName()` Internal Getter for Name.
`protected io.apimatic.core.types.OptionalNullable<Boolean>`	`internalGetSkipModifierScreen()` Internal Getter for SkipModifierScreen.
`protected io.apimatic.core.types.OptionalNullable<String>`	`internalGetSortName()` Internal Getter for SortName.
`protected io.apimatic.core.types.OptionalNullable<List<String>>`	`internalGetTaxIds()` Internal Getter for TaxIds.
`protected io.apimatic.core.types.OptionalNullable<List<CatalogObject>>`	`internalGetVariations()` Internal Getter for Variations.
`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,
                   String descriptionHtml,
                   String descriptionPlaintext)
```
    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.
    
    descriptionHtml - String value for descriptionHtml.
    
    descriptionPlaintext - String value for descriptionPlaintext.
  - CatalogItem
```
protected CatalogItem(io.apimatic.core.types.OptionalNullable<String> name,
                      io.apimatic.core.types.OptionalNullable<String> description,
                      io.apimatic.core.types.OptionalNullable<String> abbreviation,
                      io.apimatic.core.types.OptionalNullable<String> labelColor,
                      io.apimatic.core.types.OptionalNullable<Boolean> availableOnline,
                      io.apimatic.core.types.OptionalNullable<Boolean> availableForPickup,
                      io.apimatic.core.types.OptionalNullable<Boolean> availableElectronically,
                      io.apimatic.core.types.OptionalNullable<String> categoryId,
                      io.apimatic.core.types.OptionalNullable<List<String>> taxIds,
                      io.apimatic.core.types.OptionalNullable<List<CatalogItemModifierListInfo>> modifierListInfo,
                      io.apimatic.core.types.OptionalNullable<List<CatalogObject>> variations,
                      String productType,
                      io.apimatic.core.types.OptionalNullable<Boolean> skipModifierScreen,
                      io.apimatic.core.types.OptionalNullable<List<CatalogItemOptionForItem>> itemOptions,
                      io.apimatic.core.types.OptionalNullable<List<String>> imageIds,
                      io.apimatic.core.types.OptionalNullable<String> sortName,
                      io.apimatic.core.types.OptionalNullable<String> descriptionHtml,
                      String descriptionPlaintext)
```
    Internal initialization constructor.
- Method Detail
  - internalGetName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetName()
```
    Internal 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 Internal String
  - 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
  - internalGetDescription
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetDescription()
```
    Internal 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. Deprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description of the [CatalogItem](entity:CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to set the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other, except for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null does not nullify `description_html`.
    
    Returns:
    
    Returns the Internal 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. Deprecated at 2022-07-20, this field is planned to retire in 6 months. You should migrate to use `description_html` to set the description of the [CatalogItem](entity:CatalogItem) instance. The `description` and `description_html` field values are kept in sync. If you try to set the both fields, the `description_html` text value overwrites the `description` value. Updates in one field are also reflected in the other, except for when you use an early version before Square API 2022-07-20 and `description_html` is set to blank, setting the `description` value to null does not nullify `description_html`.
    
    Returns:
    
    Returns the String
  - internalGetAbbreviation
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetAbbreviation()
```
    Internal 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 Internal 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
  - internalGetLabelColor
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetLabelColor()
```
    Internal 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 Internal 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
  - internalGetAvailableOnline
```
protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetAvailableOnline()
```
    Internal Getter for AvailableOnline. If `true`, the item can be added to shipping orders from the merchant's online store.
    
    Returns:
    
    Returns the Internal Boolean
  - 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
  - internalGetAvailableForPickup
```
protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetAvailableForPickup()
```
    Internal Getter for AvailableForPickup. If `true`, the item can be added to pickup orders from the merchant's online store.
    
    Returns:
    
    Returns the Internal 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
  - internalGetAvailableElectronically
```
protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetAvailableElectronically()
```
    Internal Getter for AvailableElectronically. If `true`, the item can be added to electronically fulfilled orders from the merchant's online store.
    
    Returns:
    
    Returns the Internal 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
  - internalGetCategoryId
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetCategoryId()
```
    Internal Getter for CategoryId. The ID of the item's category, if any.
    
    Returns:
    
    Returns the Internal String
  - getCategoryId
```
public String getCategoryId()
```
    Getter for CategoryId. The ID of the item's category, if any.
    
    Returns:
    
    Returns the String
  - internalGetTaxIds
```
protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetTaxIds()
```
    Internal 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 Internal List of 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
  - internalGetModifierListInfo
```
protected io.apimatic.core.types.OptionalNullable<List<CatalogItemModifierListInfo>> internalGetModifierListInfo()
```
    Internal 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 Internal List of CatalogItemModifierListInfo
  - 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
  - internalGetVariations
```
protected io.apimatic.core.types.OptionalNullable<List<CatalogObject>> internalGetVariations()
```
    Internal Getter for Variations. A list of [CatalogItemVariation](entity:CatalogItemVariation) objects for this item. An item must have at least one variation.
    
    Returns:
    
    Returns the Internal List of CatalogObject
  - getVariations
```
public List<CatalogObject> getVariations()
```
    Getter for Variations. A list of [CatalogItemVariation](entity: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
  - internalGetSkipModifierScreen
```
protected io.apimatic.core.types.OptionalNullable<Boolean> internalGetSkipModifierScreen()
```
    Internal 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 Internal Boolean
  - 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
  - internalGetItemOptions
```
protected io.apimatic.core.types.OptionalNullable<List<CatalogItemOptionForItem>> internalGetItemOptions()
```
    Internal 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 Internal List of CatalogItemOptionForItem
  - 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
  - internalGetImageIds
```
protected io.apimatic.core.types.OptionalNullable<List<String>> internalGetImageIds()
```
    Internal 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 Internal List of String
  - 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
  - internalGetSortName
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetSortName()
```
    Internal 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. Its value must not be empty. It is currently supported for sellers of the Japanese locale only.
    
    Returns:
    
    Returns the Internal 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. Its value must not be empty. It is currently supported for sellers of the Japanese locale only.
    
    Returns:
    
    Returns the String
  - internalGetDescriptionHtml
```
protected io.apimatic.core.types.OptionalNullable<String> internalGetDescriptionHtml()
```
    Internal Getter for DescriptionHtml. The item's description as expressed in valid HTML elements. The length of this field value, including those of HTML tags, is of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or unsupported HTML elements or attributes are ignored. Supported HTML elements include: - `a`: Link. Supports linking to website URLs, email address, and telephone numbers. - `b`, `strong`: Bold text - `br`: Line break - `code`: Computer code - `div`: Section - `h1-h6`: Headings - `i`, `em`: Italics - `li`: List element - `ol`: Numbered list - `p`: Paragraph - `ul`: Bullet list - `u`: Underline Supported HTML attributes include: - `align`: Alignment of the text content - `href`: Link destination - `rel`: Relationship between link's target and source - `target`: Place to open the linked document
    
    Returns:
    
    Returns the Internal String
  - getDescriptionHtml
```
public String getDescriptionHtml()
```
    Getter for DescriptionHtml. The item's description as expressed in valid HTML elements. The length of this field value, including those of HTML tags, is of Unicode points. With application query filters, the text values of the HTML elements and attributes are searchable. Invalid or unsupported HTML elements or attributes are ignored. Supported HTML elements include: - `a`: Link. Supports linking to website URLs, email address, and telephone numbers. - `b`, `strong`: Bold text - `br`: Line break - `code`: Computer code - `div`: Section - `h1-h6`: Headings - `i`, `em`: Italics - `li`: List element - `ol`: Numbered list - `p`: Paragraph - `ul`: Bullet list - `u`: Underline Supported HTML attributes include: - `align`: Alignment of the text content - `href`: Link destination - `rel`: Relationship between link's target and source - `target`: Place to open the linked document
    
    Returns:
    
    Returns the String
  - getDescriptionPlaintext
```
public String getDescriptionPlaintext()
```
    Getter for DescriptionPlaintext. A server-generated plaintext version of the `description_html` field, without formatting tags.
    
    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

CatalogItem

Method Detail

internalGetName

getName

internalGetDescription

getDescription

internalGetAbbreviation

getAbbreviation

internalGetLabelColor

getLabelColor

internalGetAvailableOnline

getAvailableOnline

internalGetAvailableForPickup

getAvailableForPickup

internalGetAvailableElectronically

getAvailableElectronically

internalGetCategoryId

getCategoryId

internalGetTaxIds

getTaxIds

internalGetModifierListInfo

getModifierListInfo

internalGetVariations

getVariations

getProductType

internalGetSkipModifierScreen

getSkipModifierScreen

internalGetItemOptions

getItemOptions

internalGetImageIds

getImageIds

internalGetSortName

getSortName

internalGetDescriptionHtml

getDescriptionHtml

getDescriptionPlaintext

hashCode

equals

toString

toBuilder