CatalogObject.md — WooCommerce Square 2.2.5

woocommerce-square / vendor / square / connect / docs / Model / CatalogObject.md

woocommerce-square / vendor / square / connect / docs / Model Last commit date

CatalogObject.md

39 lines

1	# CatalogObject
2
3	### Description
4
5	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 [](#type-catalogitemCatalogItem](#type-catalogitem](#type-catalogitem) object. - if type = `ITEM_VARIATION`, only `item_variation_data` will be populated and it will contain a valid [](#type-catalogitemvariationCatalogItemVariation](#type-catalogitemvariation](#type-catalogitemvariation) object. - if type = `MODIFIER`, only `modifier_data` will be populated and it will contain a valid [](#type-catalogmodifierCatalogModifier](#type-catalogmodifier](#type-catalogmodifier) object. - if type = `MODIFIER_LIST`, only `modifier_list_data` will be populated and it will contain a valid [](#type-catalogmodifierlistCatalogModifierList](#type-catalogmodifierlist](#type-catalogmodifierlist) object. - if type = `CATEGORY`, only `category_data` will be populated and it will contain a valid [](#type-catalogcategoryCatalogCategory](#type-catalogcategory](#type-catalogcategory) object. - if type = `DISCOUNT`, only `discount_data` will be populated and it will contain a valid [](#type-catalogdiscountCatalogDiscount](#type-catalogdiscount](#type-catalogdiscount) object. - if type = `TAX`, only `tax_data` will be populated and it will contain a valid [](#type-catalogtaxCatalogTax](#type-catalogtax](#type-catalogtax) object. - if type = `IMAGE`, only `image_data` will be populated and it will contain a valid [](#type-catalogimageCatalogImage](#type-catalogimage](#type-catalogimage) object. For a more detailed discussion of the Catalog data model, please see the [](/catalog-api/design-a-catalogDesign a Catalog](/catalog-api/design-a-catalog](/catalog-api/design-a-catalog) guide.
6
7	## Properties
8	Name \| Getter \| Setter \| Type \| Description \| Notes
9	------------ \| ------------- \| ------------- \| ------------- \| ------------- \| -------------
10	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 [](#type-catalogobjecttypeCatalogObjectType](#type-catalogobjecttype](#type-catalogobjecttype) for possible values \|
11	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. \|
12	updated_at \| getUpdatedAt() \| setUpdatedAt($value) \| string \| Last modification [](#workingwithdatestimestamp](#workingwithdates](#workingwithdates) 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]
13	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]
14	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]
15	catalog_v1_ids \| getCatalogV1Ids() \| setCatalogV1Ids($value) \| [](CatalogV1Id.md\SquareConnect\Model\CatalogV1Id[]](CatalogV1Id.md](CatalogV1Id.md) \| The Connect V1 IDs for this object at each [](#type-locationlocation](#type-location](#type-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]
16	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]
17	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]
18	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]
19	image_id \| getImageId() \| setImageId($value) \| string \| Identifies the `CatalogImage` attached to this `CatalogObject`. \| [optional]
20	item_data \| getItemData() \| setItemData($value) \| [](CatalogItem.md\SquareConnect\Model\CatalogItem](CatalogItem.md](CatalogItem.md) \| Structured data for a [](#type-catalogitemCatalogItem](#type-catalogitem](#type-catalogitem), set for CatalogObjects of type `ITEM`. \| [optional]
21	category_data \| getCategoryData() \| setCategoryData($value) \| [](CatalogCategory.md\SquareConnect\Model\CatalogCategory](CatalogCategory.md](CatalogCategory.md) \| Structured data for a [](#type-catalogcategoryCatalogCategory](#type-catalogcategory](#type-catalogcategory), set for CatalogObjects of type `CATEGORY`. \| [optional]
22	item_variation_data \| getItemVariationData() \| setItemVariationData($value) \| [](CatalogItemVariation.md\SquareConnect\Model\CatalogItemVariation](CatalogItemVariation.md](CatalogItemVariation.md) \| Structured data for a [](#type-catalogitemvariationCatalogItemVariation](#type-catalogitemvariation](#type-catalogitemvariation), set for CatalogObjects of type `ITEM_VARIATION`. \| [optional]
23	tax_data \| getTaxData() \| setTaxData($value) \| [](CatalogTax.md\SquareConnect\Model\CatalogTax](CatalogTax.md](CatalogTax.md) \| Structured data for a [](#type-catalogtaxCatalogTax](#type-catalogtax](#type-catalogtax), set for CatalogObjects of type `TAX`. \| [optional]
24	discount_data \| getDiscountData() \| setDiscountData($value) \| [](CatalogDiscount.md\SquareConnect\Model\CatalogDiscount](CatalogDiscount.md](CatalogDiscount.md) \| Structured data for a [](#type-catalogdiscountCatalogDiscount](#type-catalogdiscount](#type-catalogdiscount), set for CatalogObjects of type `DISCOUNT`. \| [optional]
25	modifier_list_data \| getModifierListData() \| setModifierListData($value) \| [](CatalogModifierList.md\SquareConnect\Model\CatalogModifierList](CatalogModifierList.md](CatalogModifierList.md) \| Structured data for a [](#type-catalogmodifierlistCatalogModifierList](#type-catalogmodifierlist](#type-catalogmodifierlist), set for CatalogObjects of type `MODIFIER_LIST`. \| [optional]
26	modifier_data \| getModifierData() \| setModifierData($value) \| [](CatalogModifier.md\SquareConnect\Model\CatalogModifier](CatalogModifier.md](CatalogModifier.md) \| Structured data for a [](#type-catalogmodifierCatalogModifier](#type-catalogmodifier](#type-catalogmodifier), set for CatalogObjects of type `MODIFIER`. \| [optional]
27	time_period_data \| getTimePeriodData() \| setTimePeriodData($value) \| [](CatalogTimePeriod.md\SquareConnect\Model\CatalogTimePeriod](CatalogTimePeriod.md](CatalogTimePeriod.md) \| Structured data for a [](#type-catalogtimeperiodCatalogTimePeriod](#type-catalogtimeperiod](#type-catalogtimeperiod), set for CatalogObjects of type `TIME_PERIOD`. \| [optional]
28	product_set_data \| getProductSetData() \| setProductSetData($value) \| [](CatalogProductSet.md\SquareConnect\Model\CatalogProductSet](CatalogProductSet.md](CatalogProductSet.md) \| Structured data for a [](#type-catalogproductsetCatalogProductSet](#type-catalogproductset](#type-catalogproductset), set for CatalogObjects of type `PRODUCT_SET`. \| [optional]
29	pricing_rule_data \| getPricingRuleData() \| setPricingRuleData($value) \| [](CatalogPricingRule.md\SquareConnect\Model\CatalogPricingRule](CatalogPricingRule.md](CatalogPricingRule.md) \| Structured data for a [](#type-catalogpricingruleCatalogPricingRule](#type-catalogpricingrule](#type-catalogpricingrule), set for CatalogObjects of type `PRICING_RULE`. \| [optional]
30	image_data \| getImageData() \| setImageData($value) \| [](CatalogImage.md\SquareConnect\Model\CatalogImage](CatalogImage.md](CatalogImage.md) \| Structured data for a [](#type-catalogimageCatalogImage](#type-catalogimage](#type-catalogimage), set for CatalogObjects of type `IMAGE`. \| [optional]
31	measurement_unit_data \| getMeasurementUnitData() \| setMeasurementUnitData($value) \| [](CatalogMeasurementUnit.md\SquareConnect\Model\CatalogMeasurementUnit](CatalogMeasurementUnit.md](CatalogMeasurementUnit.md) \| Structured data for a [](#type-catalogmeasurementunitCatalogMeasurementUnit](#type-catalogmeasurementunit](#type-catalogmeasurementunit), set for CatalogObjects of type `MEASUREMENT_UNIT`. \| [optional]
32	item_option_data \| getItemOptionData() \| setItemOptionData($value) \| [](CatalogItemOption.md\SquareConnect\Model\CatalogItemOption](CatalogItemOption.md](CatalogItemOption.md) \| Structured data for a [](#type-catalogitemoptionCatalogItemOption](#type-catalogitemoption](#type-catalogitemoption), set for CatalogObjects of type `ITEM_OPTION`. \| [optional]
33	item_option_value_data \| getItemOptionValueData() \| setItemOptionValueData($value) \| [](CatalogItemOptionValue.md\SquareConnect\Model\CatalogItemOptionValue](CatalogItemOptionValue.md](CatalogItemOptionValue.md) \| Structured data for a [](#type-catalogitemoptionvalueCatalogItemOptionValue](#type-catalogitemoptionvalue](#type-catalogitemoptionvalue), set for CatalogObjects of type `ITEM_OPTION_VAL`. \| [optional]
34
35	Note: All properties are protected and only accessed via getters and setters.
36
37	[](../../README.md#documentation-for-models[Back to Model list]](../../README.md#documentation-for-models](../../README.md#documentation-for-models) [](../../README.md#documentation-for-api-endpoints[Back to API list]](../../README.md#documentation-for-api-endpoints](../../README.md#documentation-for-api-endpoints) [](../../README.md[Back to README]](../../README.md](../../README.md)
38
39