Module shopperExperience

campaignId: The identifier of the campaign.

• Min Length: 1
• Max Length: 256

promotionId: The identifier of the promotion within the campaign.

• Min Length: 1
• Max Length: 256

id: Component identifier.

• Max Length: 256

typeId: Component type identifier.

• Max Length: 256

name: Display name of the component.

• Max Length: 256

fragment: Indicates whether the component is a fragment. True if the component is a fragment, otherwise false.

contentLinkUuid: Represents a globally unique identifier for every instance of a content component (or fragment) rendered on a page.

• Max Length: 256

data: The configuration data assigned to the component.

localized: Whether the component has been localized with content in the current locale. If false, the components content will fallback to the default locale.

visible: Whether the component is visible based on the current visiblity rules and context.

custom: Any custom data added by the custom code for this component.

designMetadata: Design metadata of the component. This includes information about the component type definition needed by the page designer for design-time functionality.

regions: The regions (and their assigned components) for the component.

id: The id of the content asset.

• Min Length: 1
• Max Length: 256

name: The localized content asset name.

• Max Length: 4000

description: The localized content asset description.

• Max Length: 4000

pageDescription: The localized content asset page description for SEO.

• Max Length: 4000

pageKeywords: The localized content asset page keywords for SEO.

• Max Length: 4000

pageTitle: The localized content asset page title for SEO

• Max Length: 4000

id: The id of the content folder.

• Max Length: 256

parentFolderId: The id of the parent content folder.

• Max Length: 256

name: The localized content folder name.

• Max Length: 4000

description: The localized content folder description.

• Max Length: 4000

pageDescription: The localized content folder page description.

• Max Length: 4000

pageKeywords: The localized content folder page keywords.

• Max Length: 4000

pageTitle: The localized content folder page title.

• Max Length: 4000

folders: The array of content subfolders. This array can be empty.

data: List of content folders.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

data: List of content assets.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

attributeId: The ID of the refinement attribute.

• Max Length: 256

label: The localized label of the refinement attribute.

• Max Length: 4000

values: The array of refinement values.

label: The localized label of the refinement value.

• Max Length: 4000

value: The refinement value.

• Max Length: 256

hitCount: The number of search hits when this refinement value is applied.

query: The query String that was searched for.

• Max Length: 256

hits: The sorted array of search hits. Can be empty.

selectedRefinements: Map of selected refinement attribute id/value(s) pairs. The sorting order is the same like in request URL.

refinements: The sorted array of search refinements. Can be empty.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

type: The data provider type identifier.

• Min Length: 1
• Max Length: 256

id: The record identifier to resolve from the data provider.

• Min Length: 1
• Max Length: 256

title: A short, human-readable summary of the problem type. It will not change from occurrence to occurrence of the problem, except for purposes of localization

• Max Length: 256

type: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank". It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

• Max Length: 2048

detail: A human-readable explanation specific to this occurrence of the problem.

instance: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. It accepts relative URIs; this means that they must be resolved relative to the document's base URI, as per [RFC3986], Section 5.

• Max Length: 2048

id: Page identifier.

• Max Length: 256

typeId: Page type identifier.

• Max Length: 256

aspectTypeId: The aspect type assigned to the page.

• Max Length: 256

name: Display name of the page.

• Max Length: 4000

description: Description of the page.

• Max Length: 4000

pageTitle: The SEO title of the page.

• Max Length: 4000

pageDescription: The SEO description of the page.

• Max Length: 4000

pageKeywords: The SEO keywords of the page.

• Max Length: 4000

data: The configuration data assigned to the page.

custom: Any custom data added by the custom code for the page type.

visible: Whether the page is visible based on the current visiblity rules and context.

localized: Whether the page has been localized with content in the current locale. If false, the page content will fallback to the default locale.

designMetadata: Design metadata of the page. This includes information about the page type definition needed by the page designer for design-time functionality.

regions: The regions (and their assigned components) for the page.

data: List of pages.

offset: The zero-based index of the first hit/data to include in the result.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.

customerGroups: List of customer group identifiers to resolve qualification for.

campaignQualifiers: List of campaign and promotion pairs to resolve qualification for.

dataBindings: List of data binding requirements to resolve, each specifying a provider type and record identifier.

customerGroups: Map of customer group identifiers to their qualification status. True if the user is qualified, false otherwise.

campaignQualifiers: Map of campaign identifiers to a map of promotion identifiers and their qualification status. True if the user is applicable, false otherwise.

dataBindings: Resolved data binding objects grouped by provider type, then by record identifier. Used by the expression resolver to evaluate attribute expressions.

id: Region identifier.

• Max Length: 256

components: The components in the region.

limit: Maximum records to retrieve per request. The limit with its constraints (minimum, maximum, default) is defined by the request parameter limit of the endpoint returning this schema.

total: The total number of hits that match the search's criteria. This can be greater than the number of results returned as search results are pagenated.