<- Catalog API

Catalog API

Search catalog items

POST

 /v2/catalog/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.

This (SearchCatalogItems) endpoint differs from the SearchCatalogObjects endpoint in the following aspects:

  • SearchCatalogItems can only search for items or item variations, whereas SearchCatalogObjects can search for any type of catalog objects.
  • SearchCatalogItems supports the custom attribute query filters to return items or item variations that contain custom attribute values, where SearchCatalogObjects does not.
  • SearchCatalogItems does not support the include_deleted_objects filter to search for deleted items or item variations, whereas SearchCatalogObjects does.
  • The both endpoints use different call conventions, including the query filter formats.
Permissions:ITEMS_READ

Guide

Call SearchCatalogItems

Try in API Explorer
Link to section

Request body

Example code

Link to section

text_filter

string

The text filter expression to return items or item variations containing specified text in the name, description, or abbreviation attribute value of an item, or in the name, sku, or upc attribute value of an item variation.

Link to section

category_ids

string [ ]

The category id query expression to return items containing the specified category IDs.

Link to section

stock_levels

string [ ]

The stock-level query expression to return item variations with the specified stock levels.

Link to section

enabled_location_ids

string [ ]

The enabled-location query expression to return items and item variations having specified enabled locations.

Link to section

cursor

string

The pagination token, returned in the previous response, used to fetch the next batch of pending results.

Link to section

limit

integer(32-bit)

The maximum number of results to return per page. The default value is 100.

Max
100
Link to section

sort_order

string

The order to sort the results by item names. The default sort order is ascending (ASC).

Link to section

product_types

string [ ]

The product types query expression to return items or item variations having the specified product types.

Link to section

custom_attribute_filters

The customer-attribute filter to return items or item variations matching the specified custom attribute expressions. A maximum number of 10 custom attribute expressions are supported in a single call to the SearchCatalogItems endpoint.

Link to section

archived_state

string

The query filter to return not archived (ARCHIVED_STATE_NOT_ARCHIVED), archived (ARCHIVED_STATE_ARCHIVED), or either type (ARCHIVED_STATE_ALL) of items.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

items

Returned items matching the specified query expressions.

Link to section

cursor

string

Pagination token used in the next request to return more of the search result.

Link to section

matched_variation_ids

string [ ]

Ids of returned item variations matching the specified query expression.