Object Index

You are viewing an old version of the API

2022-11-16

Version 2022-11-16

• All Versions

CatalogObject

The type of this object. Each object type has expected properties expressed in a structured format within its corresponding *_data field below.

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.

Read only 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.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

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.

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.

A map (key-value pairs) of application-defined custom attribute values. The value of a key-value pair is a CatalogCustomAttributeValue object. The key is the key attribute value defined in the associated 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.).

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.

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.

A list of locations where the object is present, even if present_at_all_locations is false. This can include locations that are deactivated.

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.

Structured data for a CatalogItem, set for CatalogObjects of type ITEM.

Structured data for a CatalogCategory, set for CatalogObjects of type CATEGORY.

Structured data for a CatalogItemVariation, set for CatalogObjects of type ITEM_VARIATION.

Structured data for a CatalogTax, set for CatalogObjects of type TAX.

Structured data for a CatalogDiscount, set for CatalogObjects of type DISCOUNT.

Structured data for a CatalogModifierList, set for CatalogObjects of type MODIFIER_LIST.

Structured data for a CatalogModifier, set for CatalogObjects of type MODIFIER.

Structured data for a CatalogTimePeriod, set for CatalogObjects of type TIME_PERIOD.

Structured data for a CatalogProductSet, set for CatalogObjects of type PRODUCT_SET.

Structured data for a CatalogPricingRule, set for CatalogObjects of type PRICING_RULE. A CatalogPricingRule object often works with a CatalogProductSet object or a CatalogTimePeriod object.

Structured data for a CatalogImage, set for CatalogObjects of type IMAGE.

Structured data for a CatalogMeasurementUnit, set for CatalogObjects of type MEASUREMENT_UNIT.

Structured data for a CatalogSubscriptionPlan, set for CatalogObjects of type SUBSCRIPTION_PLAN.

Structured data for a CatalogItemOption, set for CatalogObjects of type ITEM_OPTION.

Structured data for a CatalogItemOptionValue, set for CatalogObjects of type ITEM_OPTION_VAL.

Structured data for a CatalogCustomAttributeDefinition, set for CatalogObjects of type CUSTOM_ATTRIBUTE_DEFINITION.

Structured data for a CatalogQuickAmountsSettings, set for CatalogObjects of type QUICK_AMOUNTS_SETTINGS.