recombee_api_client.api_requests.list_items module

class recombee_api_client.api_requests.list_items.ListItems(filter: str = UUID('c6eab2ab-15ca-407a-adb5-f8e4c58c7f47'), count: int = UUID('c6eab2ab-15ca-407a-adb5-f8e4c58c7f47'), offset: int = UUID('c6eab2ab-15ca-407a-adb5-f8e4c58c7f47'), return_properties: bool = UUID('c6eab2ab-15ca-407a-adb5-f8e4c58c7f47'), included_properties: list = UUID('c6eab2ab-15ca-407a-adb5-f8e4c58c7f47'))

Bases: recombee_api_client.api_requests.request.Request

Gets a list of IDs of items currently present in the catalog.

Optional parameters:

Parameters

• filter – 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 – The number of items to be listed.

• offset – Specifies the number of items to skip (ordered by itemId).

• return_properties – With returnProperties=true, property values of the listed items are returned along with their IDs in a JSON dictionary.

Example response:

```

[

E{lb}

“itemId”: “tv-178”,

“description”: “4K TV with 3D feature”,

“categories”: [“Electronics”, “Televisions”],

“price”: 342,

“url”: “myshop.com/tv-178” E{rb},

E{lb}

“itemId”: “mixer-42”,

“description”: “Stainless Steel Mixer”,

“categories”: [“Home & Kitchen”],

“price”: 39,

“url”: “myshop.com/mixer-42” E{rb}

]

```

Parameters

included_properties – 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:

```

[

E{lb}

“itemId”: “tv-178”,

“description”: “4K TV with 3D feature”,

“price”: 342 E{rb},

E{lb}

“itemId”: “mixer-42”,

“description”: “Stainless Steel Mixer”,

“price”: 39 E{rb}

]

```

get_body_parameters() → dict

Values of body parameters as a dictionary (name of parameter: value of the parameter).

get_query_parameters() → dict

Values of query parameters as a dictionary (name of parameter: value of the parameter).