Catalog
Returns a list of all CatalogObjects.
Table Specific Information
Select
The connector will execute all filters to this view client-side, in memory.
Retrieve the list of all CatalogObjects.
SELECT * from Catalog
Columns
| Name | Type | Description |
| Id [KEY] | String | A unique identifier to reference this object in the catalog. |
| Type | String | The catalog type of this object.
The allowed values are ITEM, IMAGE, CATEGORY, ITEM_VARIATION, TAX, DISCOUNT, MODIFIER_LIST, MODIFIER, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN_VARIATION, ITEM_OPTION, ITEM_OPTION_VAL, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNTS_SETTINGS, SUBSCRIPTION_PLAN, AVAILABILITY_PERIOD. |
| UpdatedAt | Datetime | Last modification timestamp in RFC 3339 format. |
| Version | Int64 | The version of the object. |
| IsDeleted | Boolean | If true, the object has been deleted from the database. When deleted, the UpdatedAt field will equal the deletion time. |
| PresentAtAllLocations | Boolean | If true, this object is present at all locations (including future locations), except where specified in the AbsentAtLocationIds field. If false, this object is not present at any locations (including future locations), except where specified in the PresentAtLocationIds field. If not specified, defaults to true. |
| PresentAtLocationIds | String | A list of locations where the object is present, even if PresentAtAllLocations is false. |
| AbsentAtLocationIds | String | A list of locations where the object is not present, even if PresentAtAllLocations is true. |
| ItemData | String | Structured data for a CatalogItem, set for CatalogObjects of type ITEM. This field is populated only if the Catalog type is ITEM. |
| CategoryData | String | Structured data for a CatalogCategory, set for CatalogObjects of type CATEGORY. This field is populated only if the Catalog type is CATEGORY. |
| ItemVariationData | String | Structured data for a CatalogItemVariation, set for CatalogObjects of type ITEM_VARIATION. This field is populated only if the Catalog type is ITEM_VARIATION. |
| TaxData | String | Structured data for a CatalogTax, set for CatalogObjects of type TAX. This field is populated only if the Catalog type is TAX. |
| DiscountData | String | Structured data for a CatalogDiscount, set for CatalogObjects of type DISCOUNT. This field is populated only if the Catalog type is DISCOUNT. |
| ModifierListData | String | Structured data for a CatalogModifierList, set for CatalogObjects of type MODIFIER_LIST. This field is populated only if the Catalog type is MODIFIER_LIST. |
| ModifierData | String | Structured data for a CatalogModifier, set for CatalogObjects of type MODIFIER. This field is populated only if the Catalog type is MODIFIER. |
| TimePeriodData | String | Structured data for a CatalogTimePeriod, set for CatalogObjects of type TIME_PERIOD. This field is populated only if the Catalog type is TIME_PERIOD. |
| ProductSetData | String | Structured data for a CatalogProductSet, set for CatalogObjects of type PRODUCT_SET. This field is populated only if the Catalog type is PRODUCT_SET. |
| PricingRuleData | String | Structured data for a CatalogPricingRule, set for CatalogObjects of type PRICING_RULE. This field is populated only if the Catalog type is PRICING_RULE. |
| ImageData | String | Structured data for a CatalogImage, set for CatalogObjects of type IMAGE. This field is populated only if the Catalog type is IMAGE. |
| MeasurementUnitData | String | Structured data for a CatalogMeasurementUnit, set for CatalogObjects of type MEASUREMENT_UNIT. This field is populated only if the Catalog type is MEASUREMENT_UNIT. |
| SubscriptionPlanData | String | Structured data for a CatalogSubscriptionPlan, set for CatalogObjects of type SUBSCRIPTION_PLAN. This field is populated only if the Catalog type is SUBSCRIPTION_PLAN. |
| ItemOptionData | String | Structured data for a CatalogItemOption, set for CatalogObjects of type ITEM_OPTION. This field is populated only if the Catalog type is ITEM_OPTION. |
| ItemOptionValueData | String | Structured data for a CatalogItemOptionValue, set for CatalogObjects of type ITEM_OPTION_VAL. This field is populated only if the Catalog type is ITEM_OPTION_VAL. |
| CustomAttributeDefinitionData | String | Structured data for a CatalogCustomAttributeDefinition, set for CatalogObjects of type CUSTOM_ATTRIBUTE_DEFINITION. This field is populated only if the Catalog type is CUSTOM_ATTRIBUTE_DEFINITION. |
| SubscriptionPlanVariationData | String | Structured data for a CatalogSubscriptionPlanVariation, set for CatalogObjects of type SUBSCRIPTION_PLAN_VARIATION. This field is populated only if the Catalog type is SUBSCRIPTION_PLAN_VARIATION. |