Skip to content

Commit

Permalink
Merge pull request #32 from rees46/feat/reccomenders-with-locations
Browse files Browse the repository at this point in the history
chore(recommendations): formatting
  • Loading branch information
TorinAsakura authored Jun 19, 2024
2 parents fea1069 + 9c7edf9 commit 74e4e72
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions source/includes/_recommendations.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,9 @@ sdk.recommend(recommender_code, params)
| 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 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 |
| 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 All @@ -146,7 +147,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 | Locations where product is available. Returned only if parameter extended is in request and 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 74e4e72

Please sign in to comment.