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
property
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
property
detail: A human-readable explanation specific to this occurrence of the problem.
property
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.
value: Locale-specific value of the Page Meta Tag, evaluated by resolving the rule set for the given Business Manager ID.
property
type: The kind of Page Meta Tag, indicating how the storefront should render the value. Documented values are name, property, title, and jsonld: * name — render as <meta name=\"...\">. * property — render as <meta property=\"...\"> (e.g. Open Graph tags). * title — render as the HTML <title> element. * jsonld — JSON-LD structured data, intended for rendering inside <script type=\"application/ld+json\">. The field may be absent when the kind cannot be determined. Clients should treat unknown values as opaque so additional kinds can be introduced without breaking the contract.
Max Length: 64
PaginatedResultBase
PaginatedResultBase:{ limit: number; offset: number; total: number } & {}
property
offset: The zero-based index of the first hit/data to include in the result.
property
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.
property
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.
maxPrice: Maximum price for the given pricebook (usually for a master Product would be the price for the Variant which has the highest price out of all Variants in that pricebook)
property
minPrice: Minimum price for the given pricebook (usually for a master Product would be the price for the Variant which has the least price out of all Variants in that pricebook)
property
pricebook: The active pricebook from which the min and the max prices are calculated. The pricebook is based on the site context of the request as defined in ECOM.
currency: A three letter uppercase currency code conforming to the ISO 4217 standard, or the string N/A indicating that a currency is not applicable.
Pattern: /^([A-Z][A-Z][A-Z]|N/A)$/
property
hitType: The type information for the search hit.
Max Length: 256
property
image: The first image of the product hit for the configured viewtype.
property
orderable: A flag indicating whether the product is orderable.
property
price: The sales price of the product. In complex products, like master or set, this is the minimum price of related child products.
property
priceMax: The maximum sales of related child products in complex products like master or set.
property
productId: The ID (SKU) of the product.
Min Length: 1
Max Length: 100
property
productName: The localized name of the product.
Max Length: 4000
property
productType: The type information for the product.
property
representedProduct: The first represented product.
property
representedProducts: All the represented products.
property
variationAttributes: The array of represented variation attributes, for the master product only. This array can be empty.
property
imageGroups: The array of product image groups.
property
priceRanges: Array of one or more price range objects representing one or more Pricebooks in context for the site.
property
productPromotions: The array of active customer product promotions for this product. This array can be empty. Coupon promotions are not returned in this array.
property
tieredPrices: The document represents list of tiered prices if the product is a variant
property
variants: The array of actual variants. Only for master, variation group, and variant types. This array can be empty.
property
variationGroups: The array of actual variation groups. Only for master, variation group, and variant types. This array can be empty.
property
slug: SEO-friendly URL slug for the product, derived from the site's configured product URL rule. Returned only when expand=slug is requested. Use the slug to construct user-friendly product detail page URLs (for example, /products/{slug}/{productId}).
attributeId: The ID of the search refinement attribute. In the case of an attribute refinement, this is the attribute ID. Custom attributes are marked by the prefix "c_" (for example, "c_refinementColor"). In the case of a category refinement, the ID must be "cgid". In the case of a price refinement, the ID must be "price".
Min Length: 1
Max Length: 256
property
label: The localized label of the refinement.
Max Length: 256
property
values: The sorted array of refinement values. This array can be empty.
description: The localized description of the refinement value.
Max Length: 4000
property
hitCount: The number of search hits when selecting the refinement value. Can be 0.
property
label: The localized label of the refinement value.
Min Length: 1
Max Length: 4000
property
presentationId: The optional presentation ID associated with the refinement value. The presentation ID can be used, for example, to associate an ID with an HTML widget.
Max Length: 256
property
value: The refinement value. In the case of an attribute refinement, this is the bucket, the attribute value, or a value range. In the case of a category refinement, this is the category ID. In the case of a price refinement, this is the price range. Ranges are enclosed by parentheses and delimited by ".."; for example, "(100..999)" and "(Aa..Fa)" are valid ranges.
Min Length: 1
Max Length: 4000
property
values: The array of hierarchical refinement values. This array can be empty.
hits: A sorted array of search hits (ProductSearchHit objects). The array can be empty.
property
pageMetaTags: Page Meta tags associated with the search result.
property
query: The query string that was searched for.
Max Length: 50
property
searchMode: The search matching approach the client requested for this search, echoed back from the searchMode query parameter. Omitted when the request did not supply one. This is the requested hint, not necessarily the mode that served the result — see effectiveSearchMode.
property
effectiveSearchMode: The search matching approach the platform actually used to serve this result. May differ from the requested searchMode when the platform demoted the mode (for example when the semantic index is unavailable).
property
processedQuery: The result of query processing.
property
refinements: The sorted array of search refinements. This array can be empty.
property
searchPhraseSuggestions: The suggestion given by the system for the submitted search phrase.
Min Length: 1
property
selectedRefinements: A map of selected refinement attribute ID or value pairs. The sorting order is the same as in request URL.
property
selectedSortingOption: The ID of the applied sorting option.
Max Length: 4000
property
sortingOptions: The sorted array of search sorting options. This array can be empty.
property
offset: The zero-based index of the first hit/data to include in the result.
property
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.
property
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.
bundle: A flag indicating whether the product is a bundle.
property
item: A flag indicating whether the product is a standard item.
property
master: A flag indicating whether the product is a master.
property
option: A flag indicating whether the product is an option.
property
set: A flag indicating whether the product is a set.
property
variant: A flag indicating whether the product is a variant.
property
variationGroup: A flag indicating whether the product is a variation group.
ResultBase
ResultBase:{ limit: number; total: number } & {}
property
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.
property
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.
SearchMode
SearchMode:"semantic" | "lexical"
A search matching approach. semantic is meaning-based matching; lexical is keyword/token-based matching.
categorySuggestions: Returns the suggested categories.
property
productSuggestions: Returns the suggested products.
property
customSuggestion: Returns custom suggestions.
property
einsteinSuggestedPhrases: Returns Einstein suggested phrases containing popular and recent search phrases.
property
searchPhrase: The query phrase (q) for which suggestions where made.
Min Length: 3
Max Length: 50
property
searchMode: The search matching approach the client requested for these suggestions, echoed back from the searchMode query parameter. Omitted when the request did not supply one. This is the requested hint, not necessarily the mode that served the suggestions — see effectiveSearchMode.
property
effectiveSearchMode: The search matching approach the platform actually used to serve these suggestions. May differ from the requested searchMode when the platform demoted the mode (for example when the semantic index is unavailable).
orderable: A flag indicating whether the variant is orderable.
property
price: The sales price of the variant.
property
productId: The ID (SKU) of the variant.
Min Length: 1
Max Length: 100
property
tieredPrices: List of tiered prices if the product is a variant
property
variationValues: The actual variation attribute ID - value pairs.
property
productPromotions: The array of active customer product promotions for this product. This array can be empty. Coupon promotions are not returned in this array.
processorName: The name of the processor.
result: The query string that was searched for.
refinements: The refinements that were applied to the query.