Endpoints that allow querying follow these format guidelines.
Field | Operators | Sorting Allowed |
---|---|---|
name | $eq ,$ne ,$hasSome ,$contains ,$startsWith | Allowed |
description | $eq ,$ne ,$hasSome ,$contains ,$startsWith | |
sku | $eq ,$ne ,$hasSome ,$contains ,$startsWith | Allowed |
id | $eq ,$ne ,$hasSome | Allowed |
price | $eq ,$ne ,$hasSome ,$lt ,$lte ,$gt ,$gte | Allowed |
numericId | $eq ,$ne ,$hasSome ,$lt ,$lte ,$gt ,$gte | Allowed |
productType | $eq ,$ne ,$hasSome | Allowed |
slug | $eq ,$ne ,$hasSome ,$contains ,$startsWith | Allowed |
collections.id | $eq ,$ne ,$hasSome ,$hasAll | |
options.\<option name\> | $eq ,$ne ,$hasSome ,$hasAll | |
inventoryStatus | $eq ,$ne ,$hasSome | |
lastUpdated | $eq ,$ne ,$hasSome ,$lt ,$lte ,$gt ,$gte | Allowed |
createdDate | $eq ,$ne ,$hasSome ,$lt ,$lte ,$gt ,$gte | Allowed |
** Note that "hasSome" is same as the operator "IN" in SQL
Query products where price = 10
Query products, order by price descending
Getting all products for a given collection
Getting multiple products by IDs
Getting all products with a specific choice
Getting all products in a store
Field | Operators | Sorting Allowed |
---|---|---|
name | $eq ,$ne ,$hasSome ,$contains ,$startsWith | Allowed |
id | $eq ,$ne ,$hasSome ,$contains ,$startsWith | Allowed |
** Note that "hasSome" is same as the operator "IN" in SQL
Query collections where name = my collection