Catalog Filters

A full reference to Liquid Commerce's Catalog API filters.

Filter Parameters

All the available options and parameters for filters when using the Catalog API to get catalog product data.

Attribute	Description
key: string	The filter key to be applied (e.g., "tags", "price")
values: string[] | object | string	The values to filter by, type depends on the filter key

Available Filters

Below are all the available filter key values that are available:

• brands: Array<string>

• flavor: Array<string>

• region: Array<string>

• variety: Array<string>

• engraving: Engraving | Binary

• fulfillment: Array<Modalities>

• presale: Binary

• tags: Array<string>

• price: object

• availability: Availability

• categories: Array<Taxonomy>

• sizes: Array<string>

• colors: Array<string>

• appellation: Array<string>

• country: Array<string>

• vintage: Array<string>

• materials: Array<string>

• collectionTags: Array<string>

Availability

Attribute	Description
AVAILABILITY_UNSPECIFIED: string	Default value when availability is not specified
IN_STOCK: string	Products currently in stock
OUT_OF_STOCK: string	Products currently out of stock
PREORDER: string	Products available for pre-order
BACKORDER: string	Products available for back-order

Engraving (deprecated, use Binary )

Attribute	Description
YES: string	Products that can be engraved
NO: string	Products that cannot be engraved

Binary

Attribute	Description
YES: string	Represents a positive condition
NO: string	Represents a negative condition

Modalities

Attribute	Context
shipping: string	Products available for shipping
onDemand: string	Products on demand

Examples for the method parameters

There are 3 different types allowed as acceptable values for the filters, object, array, string[]. Below are example of different type variation.

categories: Array<string>

{
    "key": "categories",
    "values": [
        "SPIRITS > VODKA"
    ]
}

price: object

{
    "key": "price",
    // REQUIRED: at least, min or max
    // must be provided
    "values": {
        // OPTIONAL: if omitted, accounted for as 
        // negative to infinity
        "min": 5,
        // OPTIONAL: if omitted, accounted for as 
        // positive to infinity
        "max": 29
    }
}

availability: string

{
    "key": "availability",
    // Available values: IN_STOCK | OUT_OF_STOCK
    "values": "IN_STOCK"
}

engraving: string

{
  "key": "engraving",
  "values": "YES"
}

fulfillment: Array<string>

jsonCopy{
  "key": "fulfillment",
  "values": ["onDemand"]
}

FilterSchema

All the available filter properties received from catalog response, to be used in filtering results further on consequent catalog requests.

Attribute	Description
bucket: string(Available Filters)	filter key, ex: brands, availability, category
values: Array<FilterSchemaValue>	values, has 2 properties, value & count, ex: [ { "bucket": "brands", "values": [ { "value": "TITO'S", "count": 1 } ] }, { "bucket": "categories", "values": [ { "value": "SPIRITS", "count": 1 }, { "value": "SPIRITS > VODKA", "count": 1 } ] }, ]

FilterSchemaValue

Attribute	Description
value: string	filter option
count: number	matching items count

Sample catalog filters

Catalog Filters Object

{
"filters": [
        {
            "key": "categories",
            "values": [
                "SPIRITS > VODKA"
            ]
        },
        {
            "key": "price",
            "values": {
                "min": 5,
                "max": 38
            }
        },
        {
            "key": "availability",
            "values": "IN_STOCK"
        },
        {
            "key": "collectionTags",
            "values": [
                "RESERVEBAR PICKS"
            ]
        }
    ],
}