Filter and Sort
Query Language
Endpoints that allow querying follow these format guidelines.
Fields That Allow Filtering
| Field | Operators | Sorting Allowed |
|---|---|---|
| dateCreated | $eq,$ne,$hasSome,$lt,$lte,$gt,$gte | Allowed |
| lastUpdated | $eq,$ne,$hasSome,$lt,$lte,$gt,$gte | Allowed |
| paymentStatus | $eq,$ne,$hasSome | |
| archived | $eq,$ne | |
| number | $eq,$ne,$hasSome,$lt,$lte,$gt,$gte | Allowed |
| fulfillmentStatus | $eq,$ne,$hasSome | |
| id | $eq,$ne,$hasSome | |
| lineItems.productId | $eq,$ne,$hasSome,$hasAll | |
| lineItems.name | $eq,$ne,$hasSome,$hasAll | |
| billingInfo.address.fullName | $eq,$ne,$hasSome,$contains,$startsWith | |
| buyerInfo.id | $eq,$ne,$hasSome | |
| channelInfo.type | $eq,$ne,$hasSome | |
| enteredBy.id | $eq,$ne,$hasSome | |
| channelInfo.externalOrderId | $eq,$ne,$hasSome |
** Note that "HasSome" is same as the operator "IN" in SQL
Examples
Get all paid orders
Copy
1
Get all orders, sorted by creation time
Copy
1
Get orders updated within a specific timeframe
Copy
1
Get orders by IDs
Copy
1
Was this helpful?
Yes
No