Constructor
new ListItems(optional)
Construct the request
Parameters:
| Name | Type | Description |
|---|---|---|
optional |
Object | Optional parameters given as an object with structure name of the parameter: value - Allowed parameters: - *filter* - Type: string - Description: Boolean-returning [ReQL](https://docs.recombee.com/reql.html) expression, which allows you to filter items to be listed. Only the items for which the expression is *true* will be returned. - *count* - Type: number - Description: The number of items to be listed. - *offset* - Type: number - Description: Specifies the number of items to skip (ordered by `itemId`). - *returnProperties* - Type: boolean - Description: With `returnProperties=true`, property values of the listed items are returned along with their IDs in a JSON dictionary. Example response: ``` [ { "itemId": "tv-178", "description": "4K TV with 3D feature", "categories": ["Electronics", "Televisions"], "price": 342, "url": "myshop.com/tv-178" }, { "itemId": "mixer-42", "description": "Stainless Steel Mixer", "categories": ["Home & Kitchen"], "price": 39, "url": "myshop.com/mixer-42" } ] ``` - *includedProperties* - Type: string[] - Description: Allows to specify, which properties should be returned when `returnProperties=true` is set. The properties are given as a comma-separated list. Example response for `includedProperties=description,price`: ``` [ { "itemId": "tv-178", "description": "4K TV with 3D feature", "price": 342 }, { "itemId": "mixer-42", "description": "Stainless Steel Mixer", "price": 39 } ] ``` |
- Source:
Methods
bodyParameters() → {Object}
Get body parameters
- Source:
Returns:
The values of body parameters (name of parameter: value of the parameter)
- Type
- Object
queryParameters() → {Object}
Get query parameters
- Source:
Returns:
The values of query parameters (name of parameter: value of the parameter)
- Type
- Object