Sign in
Items

List Items

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

get/{databaseId}/items/list/

Path parameters

databaseIdstring required

ID of your database.

Query parameters

filterstring

Boolean-returning ReQL expression, which allows you to filter items to be listed. Only the items for which the expression is true will be returned.

countinteger

The number of items to be listed.

offsetinteger

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

returnPropertiesboolean

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"
    }
  ]
includedPropertiesstring[]

Allows specifying 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
    }
  ]

Response

Successful operation.

itemIdstring required

Id of the item

valuesobject

Property values of the item

Changes