List Catalog Items

Retrieve list of Items from specified catalog.

Path Params
number
required
≥ 100
string
enum
required

Permitted item types.

Allowed:
Query Params

The boundary id to use for pagination.

string
enum

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

Allowed:
number

The number of items to return.

string
enum

The sort order to return items in.

Allowed:
string

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.

Responses

Language
Credentials
Header
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json