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 all 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 by the 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] |
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] |
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] |
Note: All properties are protected and only accessed via getters and setters.