Skip to content
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

fix(search): description moved from the wrong field #6

Merged
merged 1 commit into from
Apr 23, 2024
Merged

fix(search): description moved from the wrong field #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
54 changes: 27 additions & 27 deletions source/includes/_search.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ sdk.search({
| type | true | In this case: "instant_search" |
| search_query | true | Search query |
| locations | false | Comma separated list of locations IDs |
| filters_search_by | false | Available options for filter: name, quantity, popularity |


### API response
| Name | Type | Description |
Expand Down Expand Up @@ -188,32 +188,32 @@ sdk.search({

### Query Parameters

| Parameter | Required | Description |
|------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------|
| did | true | Device ID. You get it from `init` method in SDK. |
| shop_id | true | Your API key |
| sid | true | Temporary user session ID |
| type | true | In this case: "full_search" |
| search_query | true | Search query |
| limit | false | Limit of results |
| offset | false | Offset of results |
| category_limit | false | How many categories for sidebar filter to return |
| categories | false | Comma separated list of categories to filter |
| extended | false | It's better to use `true` for full search results |
| sort_by | false | Sort by parameter: `popular`, `price`, `discount`, `sales_rate`, `date` |
| order | false | Sort direction: `asc` or `desc` (default) |
| locations | false | Comma separated list of locations IDs |
| brands | false | Comma separated list of brands to filter |
| filters | false | Optional escaped JSON string with filter parameters. For example: `{"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}` |
| price_min | false | Min price |
| price_max | false | Max price |
| colors | false | Comma separated list of colors |
| fashion_sizes | false | Comma separated list of sizes |
| exclude | false | Comma separated list of products IDs to exclude from search results |
| email | false | It's only for S2S integration, when service doesn't have user's session. Mobile SDK doesn't use it. |
| no_clarification | false | Disable clarified search (true, false, default: false). Don't use it. God mode only. |
| merchants | false | Comma separated list of merchants |

| Parameter | Required | Description |
|----------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------|
| did | true | Device ID. You get it from `init` method in SDK. |
| shop_id | true | Your API key |
| sid | true | Temporary user session ID |
| type | true | In this case: "full_search" |
| search_query | true | Search query |
| limit | false | Limit of results |
| offset | false | Offset of results |
| category_limit | false | How many categories for sidebar filter to return |
| categories | false | Comma separated list of categories to filter |
| extended | false | It's better to use `true` for full search results |
| sort_by | false | Sort by parameter: `popular`, `price`, `discount`, `sales_rate`, `date` |
| order | false | Sort direction: `asc` or `desc` (default) |
| locations | false | Comma separated list of locations IDs |
| brands | false | Comma separated list of brands to filter |
| filters | false | Optional escaped JSON string with filter parameters. For example: `{"bluetooth":["yes"],"offers":["15% cashback"],"weight":["1.6"]}` |
| price_min | false | Min price |
| price_max | false | Max price |
| colors | false | Comma separated list of colors |
| fashion_sizes | false | Comma separated list of sizes |
| exclude | false | Comma separated list of products IDs to exclude from search results |
| email | false | It's only for S2S integration, when service doesn't have user's session. Mobile SDK doesn't use it. |
| no_clarification | false | Disable clarified search (true, false, default: false). Don't use it. God mode only. |
| merchants | false | Comma separated list of merchants |
| filters_search_by | false | Available options for filter: name, quantity, popularity |

### API response
| Name | Type | Description |
Expand Down
Loading