CatalogObject
April 22, 2020 · View on GitHub
Description
The wrapper object for object types in the Catalog data model. The type of a particular CatalogObject is determined by the value of type and only the corresponding data field may be set. - if type = ITEM, only item_data will be populated and it will contain a valid CatalogItem object. - if type = ITEM_VARIATION, only item_variation_data will be populated and it will contain a valid CatalogItemVariation object. - if type = MODIFIER, only modifier_data will be populated and it will contain a valid CatalogModifier object. - if type = MODIFIER_LIST, only modifier_list_data will be populated and it will contain a valid CatalogModifierList object. - if type = CATEGORY, only category_data will be populated and it will contain a valid CatalogCategory object. - if type = DISCOUNT, only discount_data will be populated and it will contain a valid CatalogDiscount object. - if type = TAX, only tax_data will be populated and it will contain a valid CatalogTax object. - if type = IMAGE, only image_data will be populated and it will contain a valid CatalogImage object. - if type = QUICK_AMOUNTS_SETTINGS, only quick_amounts_settings_data will be populated and will contain a valid CatalogQuickAmountsSettings object. For a more detailed discussion of the Catalog data model, please see the Design a Catalog guide.
Properties
| Name | Getter | Setter | Type | Description | Notes |
|---|---|---|---|---|---|
| type | getType() | setType($value) | string | The type of this object. Each object type has expected properties expressed in a structured format within its corresponding `*_data` field below. See CatalogObjectType for possible values | |
| id | getId() | setId($value) | string | 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. | |
| updated_at | getUpdatedAt() | setUpdatedAt($value) | string | Last modification timestamp 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. | [optional] |
| version | getVersion() | setVersion($value) | int | 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. | [optional] |
| is_deleted | getIsDeleted() | setIsDeleted($value) | bool | 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. | [optional] |
| custom_attribute_values | getCustomAttributeValues() | setCustomAttributeValues($value) | map[string,\SquareConnect\Model\CatalogCustomAttributeValue] | Application-defined key/value attributes that 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.). For CustomAttributesDefinitions defined by the app making the request, the map key is the key defined in the `CatalogCustomAttributeDefinition` (e.g. “reference_id”). For custom attributes created by other apps, the map key is the key defined in `CatalogCustomAttributeDefinition` prefixed with the application ID and a colon (eg. “abcd1234:reference_id”). | [optional] [beta] |
| catalog_v1_ids | getCatalogV1Ids() | setCatalogV1Ids($value) | \SquareConnect\Model\CatalogV1Id[] | 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. | [optional] |
| present_at_all_locations | getPresentAtAllLocations() | setPresentAtAllLocations($value) | bool | 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`. | [optional] |
| present_at_location_ids | getPresentAtLocationIds() | setPresentAtLocationIds($value) | string[] | A list of locations where the object is present, even if `present_at_all_locations` is `false`. | [optional] |
| absent_at_location_ids | getAbsentAtLocationIds() | setAbsentAtLocationIds($value) | string[] | A list of locations where the object is not present, even if `present_at_all_locations` is `true`. | [optional] |
| image_id | getImageId() | setImageId($value) | string | Identifies the `CatalogImage` attached to this `CatalogObject`. | [optional] |
| item_data | getItemData() | setItemData($value) | \SquareConnect\Model\CatalogItem | Structured data for a `CatalogItem`, set for CatalogObjects of type `ITEM`. | [optional] |
| category_data | getCategoryData() | setCategoryData($value) | \SquareConnect\Model\CatalogCategory | Structured data for a `CatalogCategory`, set for CatalogObjects of type `CATEGORY`. | [optional] |
| item_variation_data | getItemVariationData() | setItemVariationData($value) | \SquareConnect\Model\CatalogItemVariation | Structured data for a `CatalogItemVariation`, set for CatalogObjects of type `ITEM_VARIATION`. | [optional] |
| tax_data | getTaxData() | setTaxData($value) | \SquareConnect\Model\CatalogTax | Structured data for a `CatalogTax`, set for CatalogObjects of type `TAX`. | [optional] |
| discount_data | getDiscountData() | setDiscountData($value) | \SquareConnect\Model\CatalogDiscount | Structured data for a `CatalogDiscount`, set for CatalogObjects of type `DISCOUNT`. | [optional] |
| modifier_list_data | getModifierListData() | setModifierListData($value) | \SquareConnect\Model\CatalogModifierList | Structured data for a `CatalogModifierList`, set for CatalogObjects of type `MODIFIER_LIST`. | [optional] |
| modifier_data | getModifierData() | setModifierData($value) | \SquareConnect\Model\CatalogModifier | Structured data for a `CatalogModifier`, set for CatalogObjects of type `MODIFIER`. | [optional] |
| time_period_data | getTimePeriodData() | setTimePeriodData($value) | \SquareConnect\Model\CatalogTimePeriod | Structured data for a `CatalogTimePeriod`, set for CatalogObjects of type `TIME_PERIOD`. | [optional] |
| product_set_data | getProductSetData() | setProductSetData($value) | \SquareConnect\Model\CatalogProductSet | Structured data for a `CatalogProductSet`, set for CatalogObjects of type `PRODUCT_SET`. | [optional] |
| pricing_rule_data | getPricingRuleData() | setPricingRuleData($value) | \SquareConnect\Model\CatalogPricingRule | Structured data for a `CatalogPricingRule`, set for CatalogObjects of type `PRICING_RULE`. | [optional] |
| image_data | getImageData() | setImageData($value) | \SquareConnect\Model\CatalogImage | Structured data for a `CatalogImage`, set for CatalogObjects of type `IMAGE`. | [optional] |
| measurement_unit_data | getMeasurementUnitData() | setMeasurementUnitData($value) | \SquareConnect\Model\CatalogMeasurementUnit | Structured data for a `CatalogMeasurementUnit`, set for CatalogObjects of type `MEASUREMENT_UNIT`. | [optional] |
| item_option_data | getItemOptionData() | setItemOptionData($value) | \SquareConnect\Model\CatalogItemOption | Structured data for a `CatalogItemOption`, set for CatalogObjects of type `ITEM_OPTION`. | [optional] |
| item_option_value_data | getItemOptionValueData() | setItemOptionValueData($value) | \SquareConnect\Model\CatalogItemOptionValue | Structured data for a `CatalogItemOptionValue`, set for CatalogObjects of type `ITEM_OPTION_VAL`. | [optional] |
| custom_attribute_definition_data | getCustomAttributeDefinitionData() | setCustomAttributeDefinitionData($value) | \SquareConnect\Model\CatalogCustomAttributeDefinition | Structured data for a `CatalogCustomAttributeDefinition`, set for CatalogObjects of type `CUSTOM_ATTRIBUTE_DEFINITION`. | [optional] |
| quick_amounts_settings_data | getQuickAmountsSettingsData() | setQuickAmountsSettingsData($value) | \SquareConnect\Model\CatalogQuickAmountsSettings | Structured data for a `CatalogQuickAmountsSettings`, set for CatalogObjects of type `QUICK_AMOUNTS_SETTINGS`. | [optional] |
Note: All properties are protected and only accessed via getters and setters.