Skip to content

Commit

Permalink
Merge pull request #30 from rees46/feat/reccomenders-with-locations
Browse files Browse the repository at this point in the history 
Feat/reccomenders with locations
  • Loading branch information
@TorinAsakura
TorinAsakura authored Jun 19, 2024
2 parents e497e79 + a37118b commit c2ecec1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions source/includes/_recommendations.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ sdk.recommend(recommender_code, params)
| 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. Default is false. |
| 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. Default value is false. | |
| extended | false | If true, it will return all information about recommended products. If false - only product IDs will be returned. Default is false. |
| with_locations | false | If true and if parameter `extended` is in request and is true, the answer will return location_ids where product is available. If request doesn't have `extended` parameter or it`s false, `with_locations` parameter is ignored. Default value is false. | |
Syntax |
|-------------------------------------------------------------------------|
| <%= config[:js_sdk_name] %>("recommend", code, params, success, error); |
Expand Down Expand Up @@ -146,7 +146,7 @@ Syntax |
| extended | number | optionally | Supports: `1` or empty. If `1`, it will return all information about recommended products. If omit, it returns only products IDs. |
| prevent_shuffle | boolean | optionally | If true, it disables shuffling of products in the response. |
| page | number | optionally | The parameter for creating pagination, by default 1. Returns the number of products based on the limit per page. |
| with_locations | boolean | optionally | List of locations where product is available. Returns only if parameter extended is true. |
| with_locations | boolean | optionally | Locations where product is available. Returned only if parameter extended is in request and is true. |

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

0 comments on commit c2ecec1

Please sign in to comment.