Getting started

Formatting

Main concepts

We have 4 main bricks to our API, each one giving you access to specific features:

  • Catalog: to get all information regarding our inventory and availabilities
  • Merchant: to create carts, orders and eventually become a merchant of records
  • Supplier: to push your inventory into our platform via API
  • Reports (upcoming): to extract business intelligence and monitor your performances

In all the API responses we have consistent behavior in terms of empty strings or nullable:

  • When the value of a field is null then the field will not be returned
  • When the value of a field is an empty string then the field will be returned as ""

The documentation you are about to read is structured in the same way, walking you first through a set of common resources, authentication and glossary you need to know before interacting with the main bricks.

Happy reading!