All versions ->

Copy link to request setupRun requestRun
POST/v2/catalog/search-catalog-items

Search catalog items

Searches for catalog items or item variations by matching supported search attribute values, including custom attribute values, against one or more of the specified query filters. API Reference ->

Sign in
SandboxProduction

Access Tokens

Sign in to populate your access tokens from the developer dashboard Sign in

Link to section

Body

archived_state

string

Requested items are not archived with the is_archived attribute set to false.

Requested items are archived with the is_archived attribute set to true.

Requested items can be archived or not archived.

category_ids

string [ ]

cursor

string

A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field's value.

custom_attribute_filters

enabled_location_ids

string [ ]

limit

integer(32-bit)

product_types

sort_order

string

The results are returned in descending (e.g., newest-first or Z-A) order.

The results are returned in ascending (e.g., oldest-first or A-Z) order.

stock_levels

text_filter

string

A string that contains no characters. In an API request this value will appear as ''. Can be used to remove a field's value.

POST /v2/catalog/search-catalog-items

Response

// No response received yet.