Skip to content

docs(search): search_query_original response field description #282

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gochicus wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs(search): search_query_original response field description #282

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9973b9
docs(search): search_query_original response field description
gochicus Dec 2, 2025
f6805f3
Merge branch 'master' into feat/DEV3294-new-param-in-search-response
gochicus Dec 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 22 additions & 20 deletions source/includes/_search.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,7 @@ sdk.searchBlank()
| Name | Type | Description |
|:-----------------------|:------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| search_query | string | Search query |
Copy link

@davidgegiya davidgegiya Dec 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Нужно еще дополнить описание по этому полю. Что это фактический запрос по которому был найден товар, после преобразования внутренним алгоритмом

| search_query_original | string | Original search query. An original request is often changed by the platform to fix typos or an incorrect keyboard layout. This field shows what the original query was |
| categories | array | Array with information about categories. Each object has the following properties: |
| | | * id – category id (string) |
| | | * name – category name (string) |
Expand Down Expand Up @@ -666,26 +667,27 @@ The actual contents of the response depend on multiple factors, including:

#### Root-Level Fields

| Name | Type | Description |
|--------------------|------------------|----------------------------------------------------------------------------------------------|
| search_query | string | Search query string |
| products_total | number | Total number of found products |
| products | array of objects | List of products |
| price_range | object | Price range object |
| price_ranges | array | List of price buckets |
| price_median | number | Median product price |
| brands | array | List of brands |
| categories | array | List of categories |
| collections | array | List of collections (present even if empty) |
| industrial_filters | object | Industrial filters object |
| filters | array | List of custom filters |
| locations | array of objects | Map of aggregated locations |
| clarification | boolean | Indicates if clarification was applied |
| requests_count | number | Number of API requests in current session |
| html | string | HTML block for rendering products |
| book_authors | array | Reserved |
| keywords | array | Reserved |
| queries | array | Reserved |
| Name | Type | Description |
|-----------------------|------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| search_query | string | Search query string |
| search_query_original | string | Original search query. An original request is often changed by the platform to fix typos or an incorrect keyboard layout. This field shows what the original query was |
| products_total | number | Total number of found products |
| products | array of objects | List of products |
| price_range | object | Price range object |
| price_ranges | array | List of price buckets |
| price_median | number | Median product price |
| brands | array | List of brands |
| categories | array | List of categories |
| collections | array | List of collections (present even if empty) |
| industrial_filters | object | Industrial filters object |
| filters | array | List of custom filters |
| locations | array of objects | Map of aggregated locations |
| clarification | boolean | Indicates if clarification was applied |
| requests_count | number | Number of API requests in current session |
| html | string | HTML block for rendering products |
| book_authors | array | Reserved |
| keywords | array | Reserved |
| queries | array | Reserved |

#### Fields inside products

Expand Down