search-catalog-items-request.md

Search Catalog Items Request

Defines the request body for the SearchCatalogItems endpoint.

Structure

SearchCatalogItemsRequest

Fields

Name	Type	Tags	Description
textFilter	string | undefined	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.
categoryIds	string[] | undefined	Optional	The category id query expression to return items containing the specified category IDs.
stockLevels	string[] | undefined	Optional	The stock-level query expression to return item variations with the specified stock levels. See SearchCatalogItemsRequestStockLevel for possible values
enabledLocationIds	string[] | undefined	Optional	The enabled-location query expression to return items and item variations having specified enabled locations.
cursor	string | undefined	Optional	The pagination token, returned in the previous response, used to fetch the next batch of pending results.
limit	number | undefined	Optional	The maximum number of results to return per page. The default value is 100. Constraints: <= 100
sortOrder	string | undefined	Optional	The order (e.g., chronological or alphabetical) in which results from a request are returned.
productTypes	string[] | undefined	Optional	The product types query expression to return items or item variations having the specified product types.
customAttributeFilters	CustomAttributeFilter[] | undefined	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"
}