Sign in

v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB
Catalog Items

List Catalog Items

Retrieve list of Items from specified catalog.

get/v1/catalog/{catalogId}/{item}

Path parameters

catalogIdnumber required
item'product' | 'brand' | 'category' | 'merchant' required

Permitted item types.

Permitted item types.

Query parameters

string
OR
number

The boundary id to use for pagination.

comparison'>' | '>=' | '<' | '<='

The comparison operator to use, this requires the presence of the boundary-id parameter.

limitnumber

The number of items to return.

order'asc'

The sort order to return items in.

qstring

URI encoded Kevelog ProductQuery syntax to search for items in the catalog. Kevelog queries consist of an array of clauses, where each clause contains a field/operator pair and a value: [ [operator, field], value ]. As shorthand, you can use just the field name for equality: [ field, value ]. Multiple clauses are combined with AND logic. Supported operators include =, <, >, <=, >=, one-of, present?, matches, and matches-phrase (text fields only). Fields must be defined within the parent catalog's SearchableAttributes array.

This same syntax is used by the create-ads-from-product-query task that is submitted to the Kevel jobs /v1/jobs endpoint. This search parameter enables you to test the query before submitting your job. More information on Kevelog can be found here.

Response

List of Items.