- v1.0.0-latest-prod
Categories provide a way to group related Products for merchandising, marketing, and search results. It has a URL customers can navigate to to browse its contents as well as additional SEO related fields like a meta title and description. A Category can also have related sub-categories.
| Field | Description |
|---|---|
ID |
Unique row ID |
CONTEXT_ID |
Logical ID. Allows for sandbox versions. |
ACTIVE_START_DATE |
Start of when this category should be active. |
ACTIVE_END_DATE |
End when this category is not longer active. Unset indicates that it is always active |
ATTRIBUTES |
Dynamic attributes that are a part of the category. This is an admin-centered concept allowing additional information to be stored on a category without modifying the domain directly. |
Name |
Customer-facing name of this product. |
URL |
SEO-friendly URL to identify this category.
This is usually generated with some URL-safe version of |
DESCRIPTION |
Description of the category that can include HTML to display to customers. |
TAX_CODE |
The tax code for all products in this category. |
DISPLAY_TEMPLATE |
Defines the display template. The display template can be used to help create a unique key that drives the presentation layer destination for this category. For example, if using Spring MVC with Thymeleaf, this could be a path to a Thymeleaf template. If using a frontend view technology like React, this could point to a specific React component. |
META_TITLE |
Used for SEO data in |
META_DESCRIPTION |
sed for SEO data in |
PARENT_CATEGORY_CONTEXT_ID |
Context ID of the parent Category if this is a sub-category. |
PRODUCT_MEMBERSHIP_TYPE |
Determines how this category defines membership of its products.
Valid types include |
PRODUCT_MEMBERSHIP_RULE |
If |
SHOW_IN_SITE_MAP |
This controls whether a category should be visible on the frontend display. An example use-case for setting this to false would be a category involving a "secret specials" page, which should be hidden from general navigation and search engines, but still has a valid URL that could be sent to customers. |
EXTERNAL_ID |
Intended to hold any unique identifier not tied to datastore where this category is stored. For example, many implementations may integrate or import/export data from other systems that manage their own unique identifiers. |
CategoryProducts represent a relationship between a Category and the Products it contains.
This relationship affects what products show up in browse results when navigating to a Category by URL.
This domain provides a primary flag to signify that the the Category referenced by it is the "primary" or "main" parent of the referenced Product.
| Field | Description |
|---|---|
ID |
Unique row ID |
CONTEXT_ID |
Logical ID. Allows for sandbox versions. |
PRODUCT_CONTEXT_ID |
Context ID of the related Product. |
CATEGORY_CONTEXT_ID |
Context ID of the owning Category. |
IS_PRIMARY |
Whether this is the "primary" or "main" parent Category of the related Product. |
SORTING |
Defines the sort order of the related Product relative to all others belonging to the Category. |
A join entity that associates Categories and Products to each other in a many to many relationship, including additional information about the association. This relationship is different from Category Products as it is marketing-focused and will not impact browse or search results. Typically this is used to specify featured, cross-sale, or up-sale products as an aside to normal browse results.
| Field | Description |
|---|---|
ID |
Unique row ID |
CONTEXT_ID |
Logical ID. Allows for sandbox versions. |
CATEGORY_CONTEXT_ID |
Context ID of the owning Category |
PROMOTIONAL_PRODUCT_CONTEXT_ID |
Context ID of the Category being promoted |
PROMOTIONAL_PRODUCT_TYPE |
The type of the promotion being made such as |
SORTING |
Defines the sort order of this promotional product relative to all others belonging to a Category. |
PROMOTIONAL_MESSAGE |
A message to display to customers along with the promoted product. |
An EntityAsset associated with a Category.
|
Tip
|
EntityAssets encapsulates information related to stored, digital content such as images, videos, or text files, that belong to a particular entity. |
One of these can be marked as the primary (or default) asset to be displayed on customer-facing pages.
| Field | Description |
|---|---|
ID |
Unique row ID |
CONTEXT_ID |
Logical ID. Allows for sandbox versions. |
CATEGORY_CONTEXT_ID |
Context ID of the owning Category |
IS_PRIMARY |
Whether this is the default asset to display for the Category. |
SORTING |
Defines the sort order of this asset relative to all others belonging to a Category. |
TENANT_ID |
Context ID of the Tenant this asset belongs to. Used for resolving the actual asset content. |
APPLICATION_ID |
Context ID of the Application this asset belongs to. Used for resolving the actual asset content. |
TYPE |
Describes the general type of the asset.
This is used to determine how to render the asset on the frontend such as |
PROVIDER |
The name of the provider that is hosting the asset.
For assets hosted by the asset service itself, this should be set to |
URL |
The location used to resolve this asset.
If the |
EMBED_CODE |
If |
ALT_TEXT |
Text that corresponds to the HTML |
TITLE |
Text that corresponds to the HTML |
A category asset tag represents additional, descriptive or identifying information about an asset. These could be used to distinguish between mobile and desktop versions of assets, for instance.
| Field | Description |
|---|---|
CATEGORY_ASSET_ID |
The ID of the parent asset. |
TAG |
The actual tag value. |
Categories, Category Products, Promotional Category Products, and Category Assets are Catalog Trackable, which includes Sandbox Trackable behavior.