search-catalog-items-request.md

Search Catalog Items Request

Defines the request body for the SearchCatalogItems endpoint.

Structure

Search Catalog Items Request

Fields

Name	Type	Tags	Description
text_filter	string	Optional	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.
category_ids	List of string	Optional	The category id query expression to return items containing the specified category IDs.
stock_levels	List of str (Search Catalog Items Request Stock Level)	Optional	The stock-level query expression to return item variations with the specified stock levels. See SearchCatalogItemsRequestStockLevel for possible values
enabled_location_ids	List of string	Optional	The enabled-location query expression to return items and item variations having specified enabled locations.
cursor	string	Optional	The pagination token, returned in the previous response, used to fetch the next batch of pending results.
limit	int	Optional	The maximum number of results to return per page. The default value is 100. Constraints: <= 100
sort_order	str (Sort Order)	Optional	The order (e.g., chronological or alphabetical) in which results from a request are returned.
product_types	List of str (Catalog Item Product Type)	Optional	The product types query expression to return items or item variations having the specified product types.
custom_attribute_filters	List of Custom Attribute Filter	Optional	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.

Example (as JSON)

{
  "category_ids": [
    "WINE_CATEGORY_ID"
  ],
  "custom_attribute_filters": [
    {
      "bool_filter": true,
      "custom_attribute_definition_id": "VEGAN_DEFINITION_ID"
    },
    {
      "custom_attribute_definition_id": "BRAND_DEFINITION_ID",
      "string_filter": "Dark Horse"
    },
    {
      "key": "VINTAGE",
      "number_filter": {
        "max": "2018",
        "min": "2017"
      }
    },
    {
      "custom_attribute_definition_id": "VARIETAL_DEFINITION_ID",
      "selection_ids_filter": "MERLOT_SELECTION_ID"
    }
  ],
  "enabled_location_ids": [
    "ATL_LOCATION_ID"
  ],
  "limit": 100,
  "product_types": [
    "REGULAR"
  ],
  "sort_order": "ASC",
  "stock_levels": [
    "OUT",
    "LOW"
  ],
  "text_filter": "red"
}