CatalogObject (Square 20.0.0.20220512 API)

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

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

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

Constructor Summary

Constructors
Constructor and Description
CatalogObject(String type, String id, String updatedAt, Long version, Boolean isDeleted, Map<String,CatalogCustomAttributeValue> customAttributeValues, List<CatalogV1Id> catalogV1Ids, Boolean presentAtAllLocations, List<String> presentAtLocationIds, List<String> absentAtLocationIds, CatalogItem itemData, CatalogCategory categoryData, CatalogItemVariation itemVariationData, CatalogTax taxData, CatalogDiscount discountData, CatalogModifierList modifierListData, CatalogModifier modifierData, CatalogTimePeriod timePeriodData, CatalogProductSet productSetData, CatalogPricingRule pricingRuleData, CatalogImage imageData, CatalogMeasurementUnit measurementUnitData, CatalogSubscriptionPlan subscriptionPlanData, CatalogItemOption itemOptionData, CatalogItemOptionValue itemOptionValueData, CatalogCustomAttributeDefinition customAttributeDefinitionData, CatalogQuickAmountsSettings quickAmountsSettingsData) Initialization constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`List<String>`	`getAbsentAtLocationIds()` Getter for AbsentAtLocationIds.
`List<CatalogV1Id>`	`getCatalogV1Ids()` Getter for CatalogV1Ids.
`CatalogCategory`	`getCategoryData()` Getter for CategoryData.
`CatalogCustomAttributeDefinition`	`getCustomAttributeDefinitionData()` Getter for CustomAttributeDefinitionData.
`Map<String,CatalogCustomAttributeValue>`	`getCustomAttributeValues()` Getter for CustomAttributeValues.
`CatalogDiscount`	`getDiscountData()` Getter for DiscountData.
`String`	`getId()` Getter for Id.
`CatalogImage`	`getImageData()` Getter for ImageData.
`Boolean`	`getIsDeleted()` Getter for IsDeleted.
`CatalogItem`	`getItemData()` Getter for ItemData.
`CatalogItemOption`	`getItemOptionData()` Getter for ItemOptionData.
`CatalogItemOptionValue`	`getItemOptionValueData()` Getter for ItemOptionValueData.
`CatalogItemVariation`	`getItemVariationData()` Getter for ItemVariationData.
`CatalogMeasurementUnit`	`getMeasurementUnitData()` Getter for MeasurementUnitData.
`CatalogModifier`	`getModifierData()` Getter for ModifierData.
`CatalogModifierList`	`getModifierListData()` Getter for ModifierListData.
`Boolean`	`getPresentAtAllLocations()` Getter for PresentAtAllLocations.
`List<String>`	`getPresentAtLocationIds()` Getter for PresentAtLocationIds.
`CatalogPricingRule`	`getPricingRuleData()` Getter for PricingRuleData.
`CatalogProductSet`	`getProductSetData()` Getter for ProductSetData.
`CatalogQuickAmountsSettings`	`getQuickAmountsSettingsData()` Getter for QuickAmountsSettingsData.
`CatalogSubscriptionPlan`	`getSubscriptionPlanData()` Getter for SubscriptionPlanData.
`CatalogTax`	`getTaxData()` Getter for TaxData.
`CatalogTimePeriod`	`getTimePeriodData()` Getter for TimePeriodData.
`String`	`getType()` Getter for Type.
`String`	`getUpdatedAt()` Getter for UpdatedAt.
`Long`	`getVersion()` Getter for Version.
`int`	`hashCode()`
`CatalogObject.Builder`	`toBuilder()` Builds a new `CatalogObject.Builder` object.
`String`	`toString()` Converts this CatalogObject into string format.

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

- Constructor Detail
  - CatalogObject
```
public CatalogObject(String type,
                     String id,
                     String updatedAt,
                     Long version,
                     Boolean isDeleted,
                     Map<String,CatalogCustomAttributeValue> customAttributeValues,
                     List<CatalogV1Id> catalogV1Ids,
                     Boolean presentAtAllLocations,
                     List<String> presentAtLocationIds,
                     List<String> absentAtLocationIds,
                     CatalogItem itemData,
                     CatalogCategory categoryData,
                     CatalogItemVariation itemVariationData,
                     CatalogTax taxData,
                     CatalogDiscount discountData,
                     CatalogModifierList modifierListData,
                     CatalogModifier modifierData,
                     CatalogTimePeriod timePeriodData,
                     CatalogProductSet productSetData,
                     CatalogPricingRule pricingRuleData,
                     CatalogImage imageData,
                     CatalogMeasurementUnit measurementUnitData,
                     CatalogSubscriptionPlan subscriptionPlanData,
                     CatalogItemOption itemOptionData,
                     CatalogItemOptionValue itemOptionValueData,
                     CatalogCustomAttributeDefinition customAttributeDefinitionData,
                     CatalogQuickAmountsSettings quickAmountsSettingsData)
```
    Initialization constructor.
    
    Parameters:
    
    type - String value for type.
    
    id - String value for id.
    
    updatedAt - String value for updatedAt.
    
    version - Long value for version.
    
    isDeleted - Boolean value for isDeleted.
    
    customAttributeValues - Map of String, value for customAttributeValues.
    
    catalogV1Ids - List of CatalogV1Id value for catalogV1Ids.
    
    presentAtAllLocations - Boolean value for presentAtAllLocations.
    
    presentAtLocationIds - List of String value for presentAtLocationIds.
    
    absentAtLocationIds - List of String value for absentAtLocationIds.
    
    itemData - CatalogItem value for itemData.
    
    categoryData - CatalogCategory value for categoryData.
    
    itemVariationData - CatalogItemVariation value for itemVariationData.
    
    taxData - CatalogTax value for taxData.
    
    discountData - CatalogDiscount value for discountData.
    
    modifierListData - CatalogModifierList value for modifierListData.
    
    modifierData - CatalogModifier value for modifierData.
    
    timePeriodData - CatalogTimePeriod value for timePeriodData.
    
    productSetData - CatalogProductSet value for productSetData.
    
    pricingRuleData - CatalogPricingRule value for pricingRuleData.
    
    imageData - CatalogImage value for imageData.
    
    measurementUnitData - CatalogMeasurementUnit value for measurementUnitData.
    
    subscriptionPlanData - CatalogSubscriptionPlan value for subscriptionPlanData.
    
    itemOptionData - CatalogItemOption value for itemOptionData.
    
    itemOptionValueData - CatalogItemOptionValue value for itemOptionValueData.
    
    customAttributeDefinitionData - CatalogCustomAttributeDefinition value for customAttributeDefinitionData.
    
    quickAmountsSettingsData - CatalogQuickAmountsSettings value for quickAmountsSettingsData.
- Method Detail
  - getType
```
public String getType()
```
    Getter for Type. Possible types of CatalogObjects returned from the catalog, each containing type-specific properties in the `*_data` field corresponding to the specfied object type.
    
    Returns:
    
    Returns the String
  - getId
```
public String getId()
```
    Getter for Id. An identifier to reference this object in the catalog. When a new `CatalogObject` is inserted, the client should set the id to a temporary identifier starting with a "`#`" character. Other objects being inserted or updated within the same request may use this identifier to refer to the new object. When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references.
    
    Returns:
    
    Returns the String
  - getUpdatedAt
```
public String getUpdatedAt()
```
    Getter for UpdatedAt. Last modification [timestamp](https://developer.squareup.com/docs/build-basics/working-with-dates) in RFC 3339 format, e.g., `"2016-08-15T23:59:33.123Z"` would indicate the UTC time (denoted by `Z`) of August 15, 2016 at 23:59:33 and 123 milliseconds.
    
    Returns:
    
    Returns the String
  - getVersion
```
public Long getVersion()
```
    Getter for Version. The version of the object. When updating an object, the version supplied must match the version in the database, otherwise the write will be rejected as conflicting.
    
    Returns:
    
    Returns the Long
  - getIsDeleted
```
public Boolean getIsDeleted()
```
    Getter for IsDeleted. If `true`, the object has been deleted from the database. Must be `false` for new objects being inserted. When deleted, the `updated_at` field will equal the deletion time.
    
    Returns:
    
    Returns the Boolean
  - getCustomAttributeValues
```
public Map<String,CatalogCustomAttributeValue> getCustomAttributeValues()
```
    Getter for CustomAttributeValues. A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair is a [CatalogCustomAttributeValue]($m/CatalogCustomAttributeValue) object. The key is the `key` attribute value defined in the associated [CatalogCustomAttributeDefinition]($m/CatalogCustomAttributeDefinition) object defined by the application making the request. If the `CatalogCustomAttributeDefinition` object is defined by another application, the `CatalogCustomAttributeDefinition`'s key attribute value is prefixed by the defining application ID. For example, if the `CatalogCustomAttributeDefinition` has a `key` attribute of `"cocoa_brand"` and the defining application ID is `"abcd1234"`, the key in the map is `"abcd1234:cocoa_brand"` if the application making the request is different from the application defining the custom attribute definition. Otherwise, the key used in the map is simply `"cocoa_brand"`. Application-defined custom attributes are set at a global (location-independent) level. Custom attribute values are intended to store additional information about a catalog object or associations with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.).
    
    Returns:
    
    Returns the Map of String, CatalogCustomAttributeValue
  - getCatalogV1Ids
```
public List<CatalogV1Id> getCatalogV1Ids()
```
    Getter for CatalogV1Ids. The Connect v1 IDs for this object at each location where it is present, where they differ from the object's Connect V2 ID. The field will only be present for objects that have been created or modified by legacy APIs.
    
    Returns:
    
    Returns the List of CatalogV1Id
  - getPresentAtAllLocations
```
public Boolean getPresentAtAllLocations()
```
    Getter for PresentAtAllLocations. If `true`, this object is present at all locations (including future locations), except where specified in the `absent_at_location_ids` field. If `false`, this object is not present at any locations (including future locations), except where specified in the `present_at_location_ids` field. If not specified, defaults to `true`.
    
    Returns:
    
    Returns the Boolean
  - getPresentAtLocationIds
```
public List<String> getPresentAtLocationIds()
```
    Getter for PresentAtLocationIds. A list of locations where the object is present, even if `present_at_all_locations` is `false`. This can include locations that are deactivated.
    
    Returns:
    
    Returns the List of String
  - getAbsentAtLocationIds
```
public List<String> getAbsentAtLocationIds()
```
    Getter for AbsentAtLocationIds. A list of locations where the object is not present, even if `present_at_all_locations` is `true`. This can include locations that are deactivated.
    
    Returns:
    
    Returns the List of String
  - getItemData
```
public CatalogItem getItemData()
```
    Getter for ItemData. A [CatalogObject]($m/CatalogObject) instance of the `ITEM` type, also referred to as an item, in the catalog.
    
    Returns:
    
    Returns the CatalogItem
  - getCategoryData
```
public CatalogCategory getCategoryData()
```
    Getter for CategoryData. A category to which a `CatalogItem` instance belongs.
    
    Returns:
    
    Returns the CatalogCategory
  - getItemVariationData
```
public CatalogItemVariation getItemVariationData()
```
    Getter for ItemVariationData. An item variation, representing a product for sale, in the Catalog object model. Each [item]($m/CatalogItem) must have at least one item variation and can have at most 250 item variations. An item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked number of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both stockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass variation is sellable, but not stockable. To accurately keep track of the wine's inventory count at any time, the sellable count must be converted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes the `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count decreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.
    
    Returns:
    
    Returns the CatalogItemVariation
  - getTaxData
```
public CatalogTax getTaxData()
```
    Getter for TaxData. A tax applicable to an item.
    
    Returns:
    
    Returns the CatalogTax
  - getDiscountData
```
public CatalogDiscount getDiscountData()
```
    Getter for DiscountData. A discount applicable to items.
    
    Returns:
    
    Returns the CatalogDiscount
  - getModifierListData
```
public CatalogModifierList getModifierListData()
```
    Getter for ModifierListData. A list of modifiers applicable to items at the time of sale. For example, a "Condiments" modifier list applicable to a "Hot Dog" item may contain "Ketchup", "Mustard", and "Relish" modifiers. Use the `selection_type` field to specify whether or not multiple selections from the modifier list are allowed.
    
    Returns:
    
    Returns the CatalogModifierList
  - getModifierData
```
public CatalogModifier getModifierData()
```
    Getter for ModifierData. A modifier applicable to items at the time of sale.
    
    Returns:
    
    Returns the CatalogModifier
  - getTimePeriodData
```
public CatalogTimePeriod getTimePeriodData()
```
    Getter for TimePeriodData. Represents a time period - either a single period or a repeating period.
    
    Returns:
    
    Returns the CatalogTimePeriod
  - getProductSetData
```
public CatalogProductSet getProductSetData()
```
    Getter for ProductSetData. Represents a collection of catalog objects for the purpose of applying a `PricingRule`. Including a catalog object will include all of its subtypes. For example, including a category in a product set will include all of its items and associated item variations in the product set. Including an item in a product set will also include its item variations.
    
    Returns:
    
    Returns the CatalogProductSet
  - getPricingRuleData
```
public CatalogPricingRule getPricingRuleData()
```
    Getter for PricingRuleData. Defines how discounts are automatically applied to a set of items that match the pricing rule during the active time period.
    
    Returns:
    
    Returns the CatalogPricingRule
  - getImageData
```
public CatalogImage getImageData()
```
    Getter for ImageData. An image file to use in Square catalogs. It can be associated with `CatalogItem`, `CatalogItemVariation`, `CatalogCategory`, and `CatalogModifierList` objects. Only the images on items and item variations are exposed in Dashboard. Only the first image on an item is displayed in Square Point of Sale (SPOS). Images on items and variations are displayed through Square Online Store. Images on other object types are for use by 3rd party application developers.
    
    Returns:
    
    Returns the CatalogImage
  - getMeasurementUnitData
```
public CatalogMeasurementUnit getMeasurementUnitData()
```
    Getter for MeasurementUnitData. Represents the unit used to measure a `CatalogItemVariation` and specifies the precision for decimal quantities.
    
    Returns:
    
    Returns the CatalogMeasurementUnit
  - getSubscriptionPlanData
```
public CatalogSubscriptionPlan getSubscriptionPlanData()
```
    Getter for SubscriptionPlanData. Describes a subscription plan. For more information, see [Set Up and Manage a Subscription Plan](https://developer.squareup.com/docs/subscriptions-api/setup-plan).
    
    Returns:
    
    Returns the CatalogSubscriptionPlan
  - getItemOptionData
```
public CatalogItemOption getItemOptionData()
```
    Getter for ItemOptionData. A group of variations for a `CatalogItem`.
    
    Returns:
    
    Returns the CatalogItemOption
  - getItemOptionValueData
```
public CatalogItemOptionValue getItemOptionValueData()
```
    Getter for ItemOptionValueData. An enumerated value that can link a `CatalogItemVariation` to an item option as one of its item option values.
    
    Returns:
    
    Returns the CatalogItemOptionValue
  - getCustomAttributeDefinitionData
```
public CatalogCustomAttributeDefinition getCustomAttributeDefinitionData()
```
    Getter for CustomAttributeDefinitionData. Contains information defining a custom attribute. Custom attributes are intended to store additional information about a catalog object or to associate a catalog object with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.). [Read more about custom attributes](https://developer.squareup.com/docs/catalog-api/add-custom-attributes)
    
    Returns:
    
    Returns the CatalogCustomAttributeDefinition
  - getQuickAmountsSettingsData
```
public CatalogQuickAmountsSettings getQuickAmountsSettingsData()
```
    Getter for QuickAmountsSettingsData. A parent Catalog Object model represents a set of Quick Amounts and the settings control the amounts.
    
    Returns:
    
    Returns the CatalogQuickAmountsSettings
  - 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 CatalogObject into string format.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String representation of this class
  - toBuilder
```
public CatalogObject.Builder toBuilder()
```
    Builds a new CatalogObject.Builder object. Creates the instance with the state of the current model.
    
    Returns:
    
    a new CatalogObject.Builder object

Class CatalogObject

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CatalogObject

Method Detail

getType

getId

getUpdatedAt

getVersion

getIsDeleted

getCustomAttributeValues

getCatalogV1Ids

getPresentAtAllLocations

getPresentAtLocationIds

getAbsentAtLocationIds

getItemData

getCategoryData

getItemVariationData

getTaxData

getDiscountData

getModifierListData

getModifierData

getTimePeriodData

getProductSetData

getPricingRuleData

getImageData

getMeasurementUnitData

getSubscriptionPlanData

getItemOptionData

getItemOptionValueData

getCustomAttributeDefinitionData

getQuickAmountsSettingsData

hashCode

equals

toString

toBuilder