Browse Types

A list of shared codes.

A list of any tracking ids.

A unique system identifier.

A friendly identifier for the tag. Can be used as a search term on the storefront if #searchableByName is true. This will also be displayed as the facet value.

Message to display on a storefront such "New" or "Fairtrade" as a badge. This should support rich text (HTML) as well as plain text.

An asset that should be displayed for this tag.

Start of when this tag should be active.

End when this tag is not longer active. Unset indicates that it is always active.

Whether storefront users can find products (or other entities) with this tag by its #name.

Defines the position over a display component this tag should be displayed such as the "top-left" of a Product’s image on a list or details page. If multiple tags have the same position, then their relative order on a product or their #priority will determine which is displayed.

Defines the type of this tag such as "key feature" or "discount". This allows categorizing tags to enhance user’s ability to prioritize related tags such as only showing one "discount" tag even if a product has several.

Priority of this tag relative to other tags that may share the same #position or #type. This provides a way to pick on tag over another when there is a conflict. This could be overridden in the context of a specific product depending on the ProductTag#getSorting().

The unique identifier for the Category Asset reference.

The id for the owner of the asset.

Whether this asset is marked as the primary for the category.

The order or item attribute that this choice is stored in when the user adds to their cart.

A hint to the frontend of how to display the customer-facing input.

see DefaultAttributeChoiceType

Whether the user is required to fill out this option in order to add the product to their cart. This is always validated on cart add.

The strategy used to determine <i>when</when> this product option is validated.

How the validation should be performed.

The regex expression that should execute against the user’s value.

In case of a validation failure, this is the message that should be shown to customers.

In case of a validation failure, this is the error code that should be shown to customers.

structured input to fill out their option

The primary identifier.

string What the customer sees for display.

The value stored as an item attribute or cart attribute based on what the user selects.

How this value displays in the context of all other values within a single

Id of the author user.

Name of the author user.

Username of the author user.

The display label.

The URI it targets.

Provide any price specific context for the request.

Provide any pre-fetched price list information for the request.

One or more URIs identifying one or more Products or Categories to be fetched. The list of URIs should only apply to one entity type, i.e., they should all be product URIs or else they should all be category URIs, not a mix of both.

<blockquote>Note: In the case of a category matching, only one category may be returned.</blockquote>

Pagination parameters that can be used to filter content items or category products as appropriate. This only matters if the matching entities are content items or a category. In the case of a category, this is applied to the category’s products.

Any additional custom attributes included on this product.

Products matching the requested uris.

Category matching the requested uri.

Content items matching the requested uris.

A page of matching content items if a page request was included in the BrowseEntityRequest.

List of requested uris that did not match an entity.

Any requested ContentItem names that did not match active content.

Any requested ContentItem ids that did not match active content.

Whether any type of results are present.

The primary identifier.

The external identifier for this category.

SEO-friendly URL to identify this category.

The name of this category.

HTML-formatted description of the category.

The date after which it becomes active.

The date after which it becomes inactive.

Key-value map of additional un-typed attributes.

The list of breadcrumbs.

Defines the display template to be used.

Used for SEO data in the <title> tag

Used for SEO data in the <meta description=""> tag

This category’s parent category.

Determines how this category defines membership of its products.

The rule string used to check if a related product is a member of this category. Only applies to rule-based membership type.

The override locale used for the product membership rule

The set of assets associated with this category.

A page of products associated with this category.

A map containing a categories promotional products.

This controls whether a category should be visible on the frontend display.

The tax code for all products in this category.

The owning category’s id.

The URL of the category to retrieve

The ID of the category to retrieve

The name of the category to retrieve

The list of URLs for the categories to retrieve

The list of IDs for the categories to retrieve

The list of names for the categories to retrieve

The primary identifier.

The name of the category.

The URL of the category.

Provide Content Context to filter result

The locale used in the context.

Additional, unspecified attributes.

Id of the field.

The unique name of the field.

The type of this content field such as STRING or HTML.

When the type is REFERENCE, this field holds the type of entity this field links to such as PRODUCT or CONTENT.

When the referenceType is CONTENT, this field holds allowed content models. If empty, allows all.

Whether this field represents a collections

Whether the related FieldData requires a value.

Help text to display on the field (appears as a ? icon by the field that can be hovered over).

Hint text to display below the field in the admin (appears beneath the field, always visible).

The display order of this field in relation to other fields.

Additional attributes needed to further define this field.

The item’s ID.

A unique name for the item.

The content model for this content. Typically this only holds the model’s id and name and not the entire projection.

SEO-friendly URI to identify this content item. This will be appended to the parent ContentModel’s uri and used if the model is addressableByUri.

The individual field data for this content

Defines the beginning time for which this content item is active.

Defines the ending time for which this content item is active.

Information on the user who created this item.

Id of the model.

The unique name of this model.

Whether all of this model can be retrieved by navigating to #uri from a storefront app. For example, navigating to /blogs would result in all Content Items using the "Blog" model being fetching. Moreover, those content items would have their own URIs that would be appended to the model’s, e.g., /:ContentModel.uri/:ContentItem.uri.

SEO-friendly URI to retrieve ContentItems of this model.

The list of fields that make up this content model.

Name of the ContentZone to retrieve ContentItems for.

If present, all other request attributes will be ignored.

Names of ContentItems to retrieve.

If uri, itemIds, modelId, or modelName are present, then this will be ignored.

Ids of ContentItems to retrieve.

If uri, modelId, or modelName are present, then this will be ignored. If this is present, then itemNames will be ignored.

Name of a ContentModel all of whose ContentItems to retrieve.

If present, itemIds and itemNames will be ignored will be ignored. If uri or modelId are present, then this will be ignored.

Id of a ContentModel all of whose ContentItems to retrieve.

If present, modelId, itemIds, and itemNames will be ignored will be ignored. If uri is present, then this will be ignored.

Pagination options to use on the result set. If not provided, a list of all results will be returned instead.

URI of either a ContentModel all of whose ContentItems should be retrieved or else that of a single ContentItem. In the latter case, the parent ContentModel’s uri should be appended in the request.

Any additional params.

Unpaginated list of results. Only present if no pagination params were present in the request.

Paginated results. Only present if pagination params were present in the request.

Any requested names that did not match active content.

Any requested ids that did not match active content.

Whether any results are present.

Name of the [ContentZone] to retrieve ContentItems for.

<p> If present, all other request attributes will be ignored.

Names of ContentItems to retrieve.

<p> If uri, itemIds, modelId, or modelName are present, then this will be ignored.

Ids of ContentItems to retrieve.

<p> If uri, modelId, or modelName are present, then this will be ignored. If this is present, then itemNames will be ignored.

Name of a ContentModel all of whose ContentItems to retrieve.

<p> If present, itemIds and itemNames will be ignored will be ignored. If uri or modelId are present, then this will be ignored.

Id of a ContentModel all of whose ContentItems to retrieve.

<p> If present, modelId, itemIds, and itemNames will be ignored will be ignored. If uri is present, then this will be ignored.

Pagination options to use on the result set. If not provided, a list of all results will be returned instead.

URI of either a ContentModel all of whose ContentItems should be retrieved or else that of a single ContentItem. In the latter case, the parent ContentModel’s uri should be appended in the request.

Any additional params.

Unpaginated list of results. Only present if no pagination params were present in the request.

Paginated results. Only present if pagination params were present in the request.

Any requested names that did not match active content.

Any requested ids that did not match active content.

Whether any results are present.

The customer’s id.

The account id associated with this context.

Any customer segment ids associated with this context.

The unique identifier for the Data Driven Enum reference.

Whether an associated category exists for this data driven enum value.

The type of data driven enum (i.e. "BRAND").

The value of data driven enum (i.e. "SOME_BRAND").

The display value of data driven enum (i.e. "Some Brand").

The ID of the data driven enum to retrieve.

Whether the request should also check if an associated category exists for this data driven enum value.

The list of IDs for the data driven enums to retrieve.

Whether the request should also check if an associated category exists for this data driven enum value.

The list of data driven enums that were retrieved.

Data driven enum ids that weren’t found from the request.

The item choice is a specific Product.

The item choice a specific Variant.

The item choice is among Products from a predetermined list.

The item choice is among Variants from a predetermined list.

The item choice is among Products within a Category. Used as a convenience over specifying an explicit set of products with #SPECIFIC_PRODUCTS and a SpecificItemChoice.

The user input flow into a global cart-level attribute when added to cart. If there was already an entry for this attribute, it is overridden with the latest value.

The user value is intended to flow into an item attribute once this item is added to the cart.

Allows the user to select an additional item that is added to their cart

Values selected by the customer will help distinguish a specific variant directly on this Product that should be added to the cart. Example would be to set up t-shirts with colors and sizes. This is similar to ITEM_ATTRIBUTE in that the values the user selected are stored in the item attributes.

Denotes a simple product which has no variants or complex configuration such as a Hot Sauce. Standard products may be added to the cart on their own or they may have add-ons that get added with them.

Denotes a configurable product that has Variants determined by ProductOptions like color and size for a T-Shirt. It is the Variants which are added to the cart after the user selects the options.

Denotes a complex, configurable product that acts as a container for other Products or Variants that may be fixed or configurable. This is primarily a bundling concept. The price will be derived from the bundled items and be a range if the customer can select a varying number of the bundled items (e.g., can choose 1 or more of an item).

Denotes that the product is meant to represent a simple bundle of other products, with each bundle item represented as an IncludedProduct. The bundle has a set price that is prorated down to the included items proportionally to their original prices when viewed in an OMS. This looks like a single item to the customer when in the cart, but will be broken down in the OMS.

Denotes that the product is meant to represent a landing page that shows a selection of other products the customer can choose from. It acts somewhat like a category in that it is only for grouping other products and cannot itself be added to a cart.

This could be used as a landing page for different subscription levels for the same or similar services or products like for magazines.

Means that the tag will not be displayed anywhere.

Means that a tag is uncategorized.

Means that a tag signifies a key feature of an item such as being "Fairtrade". This is distinguished form #ATTRIBUTE insofar as a feature is intrinsic to the item rather than subjective or mutable.

Means that a tag signifies an important attribute of an item such as "New", "Staff Pick", "Seller’s Choice". This is distinguished from #FEATURE insofar as an attribute is subjective (staff pick) or mutable (new).

Means that a tag signifies a discount such as "On Sale", "20% Off", "Clearance", etc.

The width.

The height.

The depth.

The unit of measure.

The line number for the item.

The line item’s standard price.

The line item’s sale price.

The quantity of the line item.

Whether this line item is discountable.

Whether this line item is a subscription.

Any additional attributes associated with this line item.

The label for the facet.

The name of the facet.

The facet’s display order.

Whether the facet accepts multiple options.

Does the facet have ranges.

The facet ranges.

The facet rule.

The label for the facet range.

The display order for the facet range.

The minimum value of the range.

The maximum value for the range.

The search facet.

The list of values associated to the facet.

The actual value for the facet.

Whether the value is ranged

The minimum value.

The maximum value.

The number of products associated with the value.

Whether the value is active.

Id of the field.

The parent ContentItem. Usually this just contains the item’s ID and not the full projection.

The name of the field.

The value of the field.

The name of the property to filter on, e.g. "color","price", etc.

The values of the filter. For example, if name is "color", this could be "red", "black", "blue".

The ranged values of this filter. This will contain pairs of minimum and maximum values to create ranges to filter on. Cannot be used in combination with filter values.

The value of the flat rate.

The asset for this included product. Intended to override the asset normally shown for the item.

Defines the display position of this included product in relation to other included products.

Label to display for the item. This overrides the item’s name.

Fixed quantity of the item that is included with the parent product.

Unique pricing key for this particular included item.

Deprecated: The price should be on the parent product and will be prorated down to each bundled item when added to cart.

Describes whether this item’s pricing will be added to its parent or if it is included in the parent product’s price.

Deprecated: The price is always included in the parent.

Summary of the pricing information related to the included item.

The specified product if the type is "PRODUCT".

Defines the type of the item: usually a Product or Variant. see DefaultIncludedProductType

The specified amount if the type is "VARIANT".

This field contains the id of the parent product of the specified #variant if the #type is VARIANT. May be used for looking up the originating parent product rather than the bundle.

The key used during the validation of cart item’s configuration to relate this ItemChoice to one of the cart item’s dependent items.

System-wide unique identifier to configure specific pricing for the choice.

Identifies the type of items that a customer can choose from, whether specific products, specific variants, or products from a specific category.

see DefaultItemChoiceTargetType

Describes restrictions placed on the customer’s ability to select items from the targeted set. Generally, this is a restriction on how many choices can be selected for a single add-to-cart request and, potentially, how quantity is distributed among multiple selected choices.

see DefaultItemChoiceSelectionType

The maximum amount of this item that a customer can purchase at a time. If null, this would allow a customer to specify their own quantity for how many of these items they can add to the cart.

The minimum amount of the item that a customer must purchase.

The default product that can be used when driving customer selections if the targetType is "CATEGORY".

The default product that can be used when driving customer selections if the targetType is "PRODUCT".

The default variant that can be used when driving customer selections if the targetType is "VARIANT".

The ItemChoiceCategory which the choice will be chosen from by the customer if the targetType is "CATEGORY".

Holds the manually-curated options that the customer can choose from.

A specific item choice for when the targetType is SPECIFIC_PRODUCT or SPECIFIC_VARIANT.

Summary of the pricing information related to the choice.

How to treat the pricing for this choice in terms of its parent product, included or an additional cost.

Map holding any additional attributes passed in the request not matching any defined properties.

The ID of the category.

A page of products from the category to choose from.

The line item to find marketing messages for.

The location type to retrieve messages for.

The locale for the current request.

The customer context to retrieve messages for.

Any promotion codes currently in use.

The unique id for the marketing message.

Id of the parent Offer.

The actual text of the message to display.

The display order for multiple marketing messages

Determines whether this message should appear only next to its offer’s targets or qualifiers or next to both.

Determines in what locations this message can appear, whether on product detail, browse, search, or cart pages or everywhere.

The Locale to which this message is applicable.

Defines the beginning time for which this message is active

Defines the ending time for which this message is active

Means that the marketing message should appear next to applicable items on product detail pages only.

Means that the marketing message should appear on browse (list) pages only, typically in the header of the page.

Means that the marketing message should appear next to applicable items on browse (list) pages only.

Means that the marketing message should appear on the cart page, typically in the header of the page.

Means that the marketing message should appear next to applicable items on the cart page only.

The ids for all products to retrieve marketing messages for

The current category’s id

The subtotal of the customer’s cart

The ids of any products currently in the customer’s cart

The customer context information that should be used in determiningwhich offers apply

A list of currently applied offer ids

The maximum number of messages for each location and location / product combination

Messages that should be displayed on the cart page’s header

Messages that should be displayed on the product list page headers

Messages that should be displayed on individual cart items

Messages that should be displayed on individual product items shown during browse

Messages that should be display on product detail pages

Indicates that an offer’s marketing message should be displayed with items TARGETED by the offer.

Indicates that an offer’s marketing message should be displayed with items that QUALIFY an order or other items for the offer.

Indicates that the offer’s marketing message should be display on both TARGETS and QUALIFIERS.

The page number.

The size of the page.

Any sorting params to apply to the response.

The direction to sort by.

RSQL filter/s to apply to the page contents

The unique identifier for the priceable target

The type of the priceable target (i.e. "SKU")

The fields to price

Any additional attributes

The locale for the request.

The currency for the request.

Any additional attributes

Determined best price for a target.

The type of whether salePrice, standardPrice, contractPrice, etc.

Map of each type of price to each corresponding PriceTypeDetail, which contains the best overall price for that type.

The list of Price Lists.

The list of Pricable Targets

Whether the details should be hydrated on the response.

The unique identifier for the Price List

The determined best price value for this type of price from amongst all the candidates.

The corresponding type of the price: salePrice, standardPrice, contractPrice, etc.

The primary identifier.

Whether or not it is active.

The date after which it becomes active.

A list of tags sorted based on the sort position of the ProductTag for the Product with AdvancedTag#getPriority() used to break ties.

The set of assets associated with it.

Key-value map of additional un-typed attributes.

Whether or not it is available for purchase online.

The list of breadcrumbs.

The currency of the pricing data.

The description field with rich HTML markup.

Whether or not discounts may apply to it.

Whether or not it is eligible for pickup at a location.

Flat rates by fulfillment type used for simple fulfillment calculations.

A set of included products used for product bundle types.

Whether or not it is sold individually. If false, typically only sold as either an add-on or part of a bundle.

The strategy used when checking inventory for it.

The strategy used when reserving inventory for it.

The inventory type for it. Usually whether it is physical or digital.

Keyword strings associated with it.

This product is not sold itself, but is a sort of container for subordinate items.

Deprecated: use productType instead

The merchandising context of the product to signify where this item is added from. This field is intended to be used for products with type DefaultProductType#SELECTOR, which allows for the possibility of targeting the items within the selector product for discounts.

The meta description to put in meta tags for SEO purposes.

The meta title to put in meta tags for SEO purposes.

Determines how it should merge with other similar items when it gets added to a cart.

The minimum count of this product that must be added in a cart.

The maximum count of this product that must be added in a cart.

The name of this product.

Whether or not it is on sale.

Whether or not this product should be visible at all in the store.

Drives additional information that the customer should enter when purchasing this product. This can be in the form of additional variations, additional items that can be bundled with this product or simply more information that the customer needs to enter about what they are purchasing (like a personalized message).

The set of categories this product is part of.

The simple price for this product.

The price information for this product.

The primary asset for this product.

If a product option is search, the the products that use it will be index multiple times, once for each option value. Example: If a product has a color option with values red, black, silver, and this option is marked searchable, then the product will be indexed three times, once for each color. The resulting product payload when fetched from Search will include the specific option value it was indexed with such as:

A collection of products related to this product and grouped by the promotional type.

The type of product. see DefaultProductType

Summary of review information.

Whether or not this product is searchable.

The SKU code for this product.

A list of simple labels used to categorize the product

The URI for this product.

The set of variants for this product.

Soft reference to the vendor associated with this catalog. This value can be null, in which case, no vendor is associated.

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.

Any additional custom attributes included on this product.

The owning product’s id.

The id for the product to retrieve.

The url for the product to retrieve.

Any additional custom attributes included on this product.

The list product IDs to fetch.

The list of product URLs to fetch.

Any additional custom attributes included on this product.

Product ids that weren’t found from the request.

Product Uris that weren’t found from the request.

The list of products that were retrieved.

The primary identifier.

If this option came from an option template, this allows data synchronization if the template is updated.

Denotes whether this option was added from an option template by reference rather than being embedded on the Product.

The label shown to customers when displaying this option.

Controls both how the customer should be inputting values to fill out this option as well as storage of where the value will go once added to the cart.

see DefaultProductOptionType

The ordering of this option in relation to other options on the page.

Drives customer selection of an additional item to add to their cart.

Configuration for customer-driven values that flow into an attribute

A unique system identifier.

ID of the parent Product.

The AdvancedTag to associate with the #product.

Start of when this tag should be active.

End when this tag is not longer active. Unset indicates that it is always active.

Featured promotional products.

Cross-sale promotional products.

Up-sale promotional products.

Other promotional products as defined by the user.

The primary identifier for this relationship.

The promotion message for this relation.

The product to promote.

Whether this promotional product is sorted

the type of relation between the category and the related product

The rating value that we are counting.

The total count of the rating value.

The occurrence of this rating value from the total amount of ratings.

The ID of this rating

The rating of this review

The database ID of the user who authored this rating. Nullable

The customer name

The initial rating date

If edited, the date this review was edited

The title of this review

The original review. This is what is displayed on the review page

If edited, the text of the edited review

The status of this review, e.g. APPROVED, REJECTED. See RatingDetailStatus (Enum)

The admin who approved or rejected this rating.

The date that this review was approved or rejected

The rating summary. By default, only the summary ID is populated.

The reason for review rejection. Optional.

Indicated if this review is from a verified purchase

Map to capture any additional data

The rating is counted in the rating summary and does not need to undergo approval/rejection process.

The rating is awaiting an approval or rejection from the admin.

The rating has been approved and should be counted in the rating summary, as well as displayed on the product detail page.

The rating has been rejected and should not be counted in the rating summary or displayed on the product detail page.

The rating of this review.

The database ID of the user who authored this rating. Nullable

The customer name

The title of this review

The text of the review.

The id of the product or variant that is the subject of this rating.

If a Variant is being rated, this is the id of the parent product to the variant. Null if this rating is for a product.

The rating target type, such as PRODUCT or VARIANT.

The ID of this rating summary

The parent rating summary. For example, if this is a variant, this points to the RatingSummary of the parent product. Nullable.

The rating target type, such as PRODUCT or VARIANT. See RatingTargetType (Enum)

The id of the rating target. For example the product or variant ID.

The parent target ID. For example, if the target type is a Variant, this would be the product’s ID. Optional.

The total number of ratings for this target. This includes both approved and pending ratings.

The total number of approved ratings for this target. Used to calculate the average rating. Includes ratings with APPROVED or NOT_NEEDED status.

The total numerical value of all approved ratings for this summary. This is the sum of all approved ratings and is used to calculate the average rating. Includes ratings with APPROVED or NOT_NEEDED status.

Map to capture any additional data

The rating is for a product.

The rating is for a variant of a product. (Ex. A t-shirt may have different colors and sizes — each color and/or size may be considered a Variant of that t-shirt product.)

The number of reviews

The current rating.

The rating unit.

Display label for the option like "Red" for value red or option color

Name of the product option such as color

Specific value of the product option such as red

The list of standard search filters to apply.

The RSQL filters to apply.

The rule-based RSQL filters used to check if a related product is a member of the specified category. Only applies when the category’s product membership type is RULE_BASED.

The query to search for.

The redirect type.

The URI to redirect to.

The search redirect.

The search facets associated with the response.

The sorting parameters associated to the response.

If no results were found and a different query was executed than the original, this is set to true.

Set if spellcheck returned any results. Contains the original query and any potential suggestions.

The query to use for suggestions.

The type ahead configuration name.

The list of standard search filters to apply.

The RSQL filters to apply.

The suggestions returned by the search service.

Any additional custom attributes included on this product.

The label for the sort option.

The name of the sort option.

The display order of the sort option.

The sort option.

WHether the sort option is active.

Wheather the sort is ascending or descending.

System-wide unique identifier to configure specific pricing for the choice.

How to treat the pricing for this choice in terms of its parent product, included or an additional cost.

Whether this item holds a product or a variant that the customer can select from

The product for this choice

The variant for this choice

Summary of the pricing information related to the choice.

Map holding any additional attributes passed in the request not matching any defined properties.

Additional override price information if a specific variant is selected.

The original search query.

The suggested queries as result of the spellcheck.

The suggested query to replace the original query.

The number of hits for the suggested query.

The primary identifier.

Whether or not it is active.

The date after which it becomes active.

The date after which it becomes inactive.

Key-value map of additional un-typed attributes.

Can be used in display or as apart of more complex pricing algorithms.

The default price that should be used if there is not a salePrice set.

The description field with rich HTML markup.

The dimensions of this variant.

Whether or not discounts may apply to it.

Flat rates by fulfillment type used for simple fulfillment calculations.

The strategy used when checking inventory for it.

The strategy used when reserving inventory for it.

The minimum count of this product that must be added in a cart.

The maximum count of this product that must be added in a cart.

The name of this variant.

Whether or not it is on sale.

Whether or not this product should be visible at all in the store.

Helper to make this particular variant uniquely identifiable across multiple variants for the same product.

The price information for this product.

The primary asset for this product.

The link to the product that this variant is a part of.

A collection of products related to this product and grouped by the promotional type.

Summary of review information.

Whether or not this product is searchable.

The SKU code for this product.

Indicates that this product is on sale.

The tax code for this variant.

Universal product code that defines this particular variant of the product.

The URI for this product.

The weight of this variant.

Any additional custom attributes included on this product.

The price for the override.

Summary of the pricing information related to the override.

The pricing key for this price.

The id of the Variant this price applies to.

The weight.

The unit of measure.