Update searchCategory query examples and responses#337
Open
Conversation
meker12
commented
Apr 21, 2026
Co-authored-by: Margaret Eker <meker@adobe.com>
meker12
commented
Apr 21, 2026
meker12
commented
Apr 21, 2026
Co-authored-by: Margaret Eker <meker@adobe.com>
keharper
approved these changes
Apr 21, 2026
| The `searchCategory` query matches category **names** against a `searchTerm` and returns a paginated [`SearchCategoryResultPage`](https://developer.adobe.com/commerce/services/graphql-api/merchandising-api/index.html#definition-SearchCategoryResultPage). | ||
|
|
||
| - If the `family` argument is omitted, it returns categories across all families. | ||
| - The `searchTerm` argument is case-insensitive and must be a minimum of three characters. |
Contributor
There was a problem hiding this comment.
Suggested change
| - The `searchTerm` argument is case-insensitive and must be a minimum of three characters. | |
| - The `searchTerm` argument is case-insensitive and must be a minimum of three characters. |
| ### Search categories by name | ||
|
|
||
| Shoppers and internal tools often find categories by typing a fragment of the display name rather than browsing the tree. The following example calls `searchCategory` with `searchTerm: "Shorts"` and no `family`, then requests `totalCount`, a page of `items` with `slug`, `name`, and `level`, plus `pageInfo` for pagination. The response lists every category whose name matches across the catalog scope your API uses. | ||
| Shoppers and internal tools often find categories by typing a fragment of the display name rather than browsing the tree. The following example calls `searchCategory` with `searchTerm: "Men"` and no `family`, then requests `totalCount`, a page of `items` with `slug`, `name`, and `level`, plus `pageInfo` for pagination. The response lists every category whose name matches across the catalog scope your API uses. |
Contributor
There was a problem hiding this comment.
Suggested change
| Shoppers and internal tools often find categories by typing a fragment of the display name rather than browsing the tree. The following example calls `searchCategory` with `searchTerm: "Men"` and no `family`, then requests `totalCount`, a page of `items` with `slug`, `name`, and `level`, plus `pageInfo` for pagination. The response lists every category whose name matches across the catalog scope your API uses. | |
| Shoppers and internal tools often find categories by typing a fragment of the display name rather than browsing the tree. The following example calls `searchCategory` with `searchTerm: "Men"` and no `family`, then requests `totalCount`, a page of `items` with `slug`, `name`, and `level`. The response lists every category whose name matches across the catalog scope your API uses. |
You removed pageInfo from your query. I'm not sure if you really should, given you link to it below. But then, I'm only looking at a diff, not the whole topic.
github-project-automation
Bot
moved this from 📋 Needs Review
to 👍 Approved
in Commerce - Pull Requests
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose of this pull request
Updates the
searchCategoryquery explanation in the Implement categories on the storefront topicJIRA: COMOPT-1969
Affected pages
https://developer.adobe.com/commerce/services/optimizer/merchandising-services/categories-storefront-implementation/