Skip to content

Ecommerce Search 26.0

Version 26.0
Release Date 2 March 2026

Changes

Upgrade instructions

Unified Search response model changes

The return models for suggestions, didYouMean, relatedTags, and aiRelatedTags have changed from simple string arrays to object arrays. This provides information about which data sources have hits for each suggestion or tag and allows for future extensibility.

Field V25 (old) V26 (new)
suggestions string[] { phrase, hits[] }[]
didYouMean string[] { phrase }[]
relatedTags { suggestionPhrase, tag }[] { phrase, hits[], tag }[]
aiRelatedTags string[] { phrase, hits[] }[]

See Unified Search - Breaking changes in V26 for more details and examples.

The response also includes two new fields:

  • popularSearches — popular search phrases to display when the search box is focused with an empty query. Only populated when the scope has popular searches enabled and the search phrase is empty.
  • action — redirect actions detected during the search. When present, the client should follow the redirect instead of displaying search results. The action.redirect.filters object contains key-value pairs where the key is a field name (e.g. CategoryIds, ProductId, SkuId, or a custom attribute fieldId) and the value is the target identifier.

StringAttribute renamed to StringAttributes

stringAttribute has been renamed to stringAttributes on the product, sku, and content response models. This affects the following models:

  • SearchSkuInformationModel
  • SearchSkuModel
  • ContentModel

Export

The /export endpoint has changed:

  • The pageToken request field has been renamed to nextPageToken.
  • The total field has been removed from the response. Use the nextPageToken to determine when the export has ended — when it is null, there are no more pages.
  • The number of returned results may not match the requested numberOfResults. Some responses may not contain any data at all. Continue paging until nextPageToken is null.

stringAttribute has been renamed to stringAttributes on the export result model as well.

CategoryName field is obsolete

CategoryName should no longer be used as an allowed filter or scope field. Use Categories instead. The key will be the categoryId, while the name will contain the categoryName.

ParameterType Boolean and Top are obsolete

The parameter types Boolean and Top have been removed from the ParameterType enum. They have not been supported for a long time.

New features

Experience tags

Experiences can now have tags associated with them. Tags can be managed via new API endpoints and can also be suggested by AI based on the experience's conditions.

Enhancements

None

New or updated endpoints (v26)

Admin Api

Endpoint Comment
GET /api/segments/{segmentId}/experiences/{experienceId}/tags New. Retrieves the tags associated with a specific experience.
POST /api/segments/{segmentId}/experiences/{experienceId}/tags/bulk New. Updates the tags associated with an experience.
POST /api/segments/{segmentId}/experiences/tags/ai-suggest New. Suggests tags for an experience based on its conditions using AI.
POST /api/segments/{segmentId}/allowed-filters/bulk The endpoint only allows existing fields. The CategoryName field has been obsoleted. Use Categories instead.
POST /api/segments/{segmentId}/scopes/{scopeId} The CategoryName field has been obsoleted. Use Categories instead.

Search Api

Endpoint Comment
POST /search Response model updated for suggestions, didYouMean, relatedTags, and aiRelatedTags (now object arrays). New popularSearches and action fields added. stringAttribute renamed to stringAttributes.
POST /export pageToken renamed to nextPageToken. total removed from response. stringAttribute renamed to stringAttributes.

Deprecations

V24 is now out of service and will be removed soon.

Admin Api

Endpoint Comment
GET /api/ai-assistant/settings Removed. AI Assistant settings for the frontend.
GET /api/language/translations Removed. Translations endpoint.
POST /api/segments/{segmentId}/product-preview/available-facet-values Removed. Use the experience preview endpoints instead.
POST /api/segments/{segmentId}/product-preview/search Removed. Use the experience preview endpoints instead.

Other deprecations

See release notes for 26.x for other endpoints that are removed in upcoming versions.