Query Language

Most of the models that we expose via our API support list queries i.e. fetching a collection of models in a single request. These queries may be filtered via query parameters.

One of the most common filters is the seller filter which lets you query for objects owned by a particular seller:

GET /api/orders?seller=SELLER_ID

You can find a seller's SELLER_ID by looking at their checkout button HTML code, for example:

<div 
	class="xola-checkout" 
	data-seller="63e1509a461784660477325c" 
	data-experience="63e1645966d5b4198a2460ec" 
	data-version="2">
</div>

👍

Authorization

Xola will automatically apply authorization filters to any query you perform. The results returned will only contain data that your credentials authorize you to view. So if you try to query for orders that belong to a seller you don't have access to, you will get zero results.

A more interesting query might be to find orders arriving on a particular day for that seller:

GET /api/orders?seller=SELLER_ID&arrival=2019-11-09

Advanced Queries

The above examples show how to perform exact matches. What if you wanted to find orders across a range of arrival dates, say Nov 8 to Nov 10? Here are a few different ways you could accomplish that:

GET /api/orders?items.arrival[in]=2019-11-08,2019-11-09,2019-11-10

GET /api/orders?items.arrival[gte]=2019-11-08&items.arrival[lte]=2019-11-10

GET /api/orders?items.arrival[range]=2019-11-08,2019-11-10

Supported Operators

Apart from the operators demonstrated in the above examples, we support many more. Some operators are limited to certain types of fields.