URL query parameters

Query URL parameters consist of key-value pairs that help customize the content of collection and blog pages, allowing for more specific requests.

For example /collection/our-versions?type=software&vendor=Cradle&price=>100&tags=cms&sort=price-asc will show products with the product type equal to software that has vendor Cradle and a price over 100 a tag cms with the list shown with price in ascending order.

Sorting options

sort=price-asc

    "alpha-asc":      "title asc",       //Alphabetically A-Z
    "alpha-desc":     "title desc",      //Alphabetically Z-A
    "title-asc":      "title asc",       //Alphabetically A-Z
    "title-desc":     "title desc",      //Alphabetically Z-A
    "price-desc":     "price_max desc",  //By price highest to lowest
    "price-asc":      "price_min asc",   //By price lowest to highest
    "created-desc":   "id desc",         //Creation date newest to oldest
    "created-asc":    "id asc",          //Creation date oldest to newest
    "published-desc": "publish_at desc", //Publish date newest to oldest
    "published-asc":  "publish_at asc",  //Publish date oldest to newest
    "updated-desc":   "updated_at desc", //Update date newest to oldest
    "updated-asc":    "updated_at asc",  //Update date oldest to newest

Search options

   "tag":              {"equals", "contains", "starts_with", "ends_with"}, // tagged with
    "type":             {"equals", "contains", "starts_with", "ends_with"}, // type
    "title":            {"equals", "contains", "starts_with", "ends_with"}, // title
    "vendor":           {"equals", "contains", "starts_with", "ends_with"}, // vendor
    "variant":          {"equals", "contains"},                             // variant
    "price":            {"equals", "greater_than", "less_than"},            // price
    "compare_at_price": {"equals", "greater_than", "less_than"},            // compare at price
    "price-min":        {"equals"},                                         // price_min >=
    "price-max":        {"equals"},                                         // price_max <=
    "sale":             {"equals"},                                         // on sale (compare_at_price > price)

Operators

For tags

"and" : ",",
"or" : "+"

Example with “and” and “or” for tags

tags=a+b,c+d : “(a OR b) AND (b OR c)”

General

"contains": "%",
"equals": "=",
"not": "!",
"greater_than": ">",
"less_than": "<",
"starts_with": "^",
"ends_with": "$",