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.
The type of a particular CatalogObject
is determined by the value of the
type
attribute and only the corresponding data attribute can be set on the CatalogObject
instance.
For example, the following list shows some instances of CatalogObject
of a given type
and
their corresponding data attribute that can be set:
- For a
CatalogObject
of theITEM
type, set theitem_data
attribute to yield theCatalogItem
object. - For a
CatalogObject
of theITEM_VARIATION
type, set theitem_variation_data
attribute to yield theCatalogItemVariation
object. - For a
CatalogObject
of theMODIFIER
type, set themodifier_data
attribute to yield theCatalogModifier
object. - For a
CatalogObject
of theMODIFIER_LIST
type, set themodifier_list_data
attribute to yield theCatalogModifierList
object. - For a
CatalogObject
of theCATEGORY
type, set thecategory_data
attribute to yield theCatalogCategory
object. - For a
CatalogObject
of theDISCOUNT
type, set thediscount_data
attribute to yield theCatalogDiscount
object. - For a
CatalogObject
of theTAX
type, set thetax_data
attribute to yield theCatalogTax
object. - For a
CatalogObject
of theIMAGE
type, set theimage_data
attribute to yield theCatalogImageData
object. - For a
CatalogObject
of theQUICK_AMOUNTS_SETTINGS
type, set thequick_amounts_settings_data
attribute to yield theCatalogQuickAmountsSettings
object. - For a
CatalogObject
of thePRICING_RULE
type, set thepricing_rule_data
attribute to yield theCatalogPricingRule
object. - For a
CatalogObject
of theTIME_PERIOD
type, set thetime_period_data
attribute to yield theCatalogTimePeriod
object. - For a
CatalogObject
of thePRODUCT_SET
type, set theproduct_set_data
attribute to yield theCatalogProductSet
object. - For a
CatalogObject
of theSUBSCRIPTION_PLAN
type, set thesubscription_plan_data
attribute to yield theCatalogSubscriptionPlan
object.
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 that 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 |
image_
|
Identifies the |
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_
Beta
|
Structured data for a |
subscription_
Beta
|
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 |