Object Index
You are viewing an old version of the API
CatalogObject
Object Index
The wrapper object for the catalog entries of a given object type.
Depending on the type
attribute value, a CatalogObject
instance assumes a type-specific data to yield the corresponding type of catalog object.
For example, if type=ITEM
, the CatalogObject
instance must have the ITEM-specific data set on the item_data
attribute. The resulting CatalogObject
instance is also a CatalogItem
instance.
In general, if type=<OBJECT_TYPE>
, the CatalogObject
instance must have the <OBJECT_TYPE>
-specific data set on the <object_type>_data
attribute. The resulting CatalogObject
instance is also a Catalog<ObjectType>
instance.
For a more detailed discussion of the Catalog data model, please see the Design a Catalog guide.
Properties
Name | Description |
---|---|
type
Required
|
The type of this object. Each object type has expected
properties expressed in a structured format within its corresponding |
id
Required
|
An identifier to reference this object in the catalog. When a new When the server receives the new object, it will supply a unique identifier that replaces the temporary identifier for all future references. |
updated_
|
Read only Last modification timestamp in RFC 3339 format, e.g., 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 |
version
|
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. |
is_
|
If |
custom_
Beta
|
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 If the 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.). |
catalog_
|
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. |
present_
|
If |
present_
|
A list of locations where the object is present, even if |
absent_
|
A list of locations where the object is not present, even if |
item_
|
Structured data for a |
category_
|
Structured data for a |
item_
|
Structured data for a |
tax_
|
Structured data for a |
discount_
|
Structured data for a |
modifier_
|
Structured data for a |
modifier_
|
Structured data for a |
time_
|
Structured data for a |
product_
|
Structured data for a |
pricing_
|
Structured data for a |
image_
|
Structured data for a |
measurement_
|
Structured data for a |
subscription_
|
Structured data for a |
item_
Beta
|
Structured data for a |
item_
Beta
|
Structured data for a |
custom_
Beta
|
Structured data for a |
quick_
Beta
|
Structured data for a |