Skip to content

Commit

Permalink
Merge pull request #24 from rees46/feat/recomendation-parameters
Browse files Browse the repository at this point in the history 
docs(reccomendations): new params description
  • Loading branch information
@TorinAsakura
TorinAsakura authored Jun 17, 2024
2 parents a7c808b + fb63365 commit cf74f6e
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions source/includes/_recommendations.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,15 @@ sdk.recommend(recommender_code, params)

### 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 |
| recommender_code | true | ID of product recommendations block. You get it from blocks management UI. |
| resize_image | false | Image size (px) to resize. Supported: 120, 140, 160, 180, 200, 220. |
| extended | false | Supports: `1` or empty. If `1`, it will return all information about recommended products. If omit, it returns only products IDs. |
| 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 |
| recommender_code | true | ID of product recommendations block. You get it from blocks management UI. |
| resize_image | false | Image size (px) to resize. Supported: 120, 140, 160, 180, 200, 220. |
| extended | false | If true, it will return all information about recommended products. If parameter with_locations is present in request and is true, location_ids column with a list of locations where product is available will be returned. If omit, it returns only products IDs. |
| with_locations | false | If true and if parameter extended is in request, it will return location_ids column with a list of locations where product is available. If request doesn't have `extended` parameter, `with_locations` parameter is ignored. | |

### JS SDK syntax
| Syntax |
Expand Down

0 comments on commit cf74f6e

Please sign in to comment.