OrderingPlus API Guidelines

OrderingPlus is the best and easiest way to build any kind of OrderingPlus Solution. You can even create your Online OrderingPlus Marketplace; our APIs include all the power of our backend, so you don't need to build one to create amazing Apps or OrderingPlus Solutions.

Like any API, certain functions are defined that can be used to interact with your OrderingPlus project and utilize its resources.

You can obtain the list of orders that belong to your project and apply filters to them

​https://api.orderingplus.com/v400/<language_code>/<project_id>/orders?orderBy=-id&page=1&page_size=10&mode=dashboard

Usage example
​

It's possible to retrieve the list of orders using specific filters. This allows for more specific order retrieval. Some of the filters that can be used include:

Usage example
​

​https://api.orderingplus.com/v400/en/projectdc/orders?orderBy=-id&page=1&page_size=10&where={%22conditions%22:[{%22conector%22:%22OR%22,%22conditions%22:[{%22attribute%22:%22products%22,%22conditions%22:[{%22attribute%22:%22type%22,%22value%22:{%22condition%22:%22=%22,%22value%22:%22item%22}}]},{%22attribute%22:%22cloned_order_id%22,%22value%22:{%22condition%22:%22!=%22,%22value%22:null}}]},{%22attribute%22:%22status%22,%22value%22:[0]}],%22conector%22:%22AND%22}&mode=dashboard

You can obtain the complete list of your businesses from your project.

Usage example:

The easiest way to request the list of businesses is through the following endpoint:

https://api.orderingplus.com/v400/<langue_code>/<project_id>/business?mode=dashboard

NOTE: Don't forget to replace "<project_id>" with your project's identifier and <language_code> with “en” or with the code of your language.

Now, you simply need to use the endpoint using the "GET" request type and add your "x-api-key" as the "Authorization" of the request.

Usage example

When attempting this, you may encounter an error due to the potentially high payload of requested data in JSON format. To address this, parameters should be used.

For example, if we only want to request the "name" value of the business, we can add these parameters to the request. Additionally, we include "page=1&page_size=10" to limit the result per page:

https://api.orderingplus.com/v400/en/<project_id>/business?page=1&page_size=10&params=name&mode=dashboard

Usage example

The API will return reduced information, including only some minimal data. If you want to add additional data, you just need to include it, for example, the "location":

We can also observe that the same endpoint is used in the dashboard but with additional parameters added. This can be useful for comparing information regarding the usage of certain endpoints:

​

Some parameters compatible with the business endpoint are:

To get categories and product info, the following endpoint can be used:

https://api.orderingplus.com/v400/en/<project>/business/<business_slug>?params=id,categories,name,slug,description&mode=dashboard

To send this request, a "GET" method is used, and it requires using the Authorization with an x-api-key, as you can see in the following image:

Usage example

You can view the products within each category.
​