Filter and sort

Query Language

Endpoints that allow querying follow these format guidelines.

Query Products

Fields That Allow Filtering

FieldOperatorsSorting Allowed
name$eq,$ne,$hasSome,$contains,$startsWithAllowed
description$eq,$ne,$hasSome,$contains,$startsWith
sku$eq,$ne,$hasSome,$contains,$startsWithAllowed
id$eq,$ne,$hasSomeAllowed
price$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
numericId$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
productType$eq,$ne,$hasSomeAllowed
slug$eq,$ne,$hasSome,$contains,$startsWithAllowed
collections.id$eq,$ne,$hasSome,$hasAll
options.\<option name\>$eq,$ne,$hasSome,$hasAll
inventoryStatus$eq,$ne,$hasSome
lastUpdated$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed
createdDate$eq,$ne,$hasSome,$lt,$lte,$gt,$gteAllowed

** Note that "hasSome" is same as the operator "IN" in SQL

Examples

Query products where price = 10

Copy

Query products, order by price descending

Copy

Getting all products for a given collection

Copy

Getting multiple products by IDs

Copy

Getting all products with a specific choice

Copy

Getting all products in a store

  1. Get the first page:
Copy
  1. Take the numericId of the last returned item and run the following query:
Copy
  1. Continue until no more records are returned.

Query Collections

Fields That Allow Filtering

FieldOperatorsSorting Allowed
name$eq,$ne,$hasSome,$contains,$startsWithAllowed
id$eq,$ne,$hasSome,$contains,$startsWithAllowed

** Note that "hasSome" is same as the operator "IN" in SQL

Examples

Query collections where name = my collection

Copy
Did this help?