The goal of this documentation is to comprehensively explain the shopwave API, both from a reference as well as a conceptual point of view. We are also aiming to get good consistency level across our documentations as well as our API. Each endpoints describes a HTTP method or high-level concept.
Where appropriate, we have provided code snippets and corresponding comments.
Every endpoints and its methods will be explained as,
We are constantly improving our documentation. If you have problem understanding or if we are wrong explaining shopwave API, please don't hesitate us to contact us.
At top of each endpoint methods you will find our stability index. This will tell you how safe is to use the method.
Our stability index directly affect our versions and release roadmap.
Our developers are working really hard on it. Its not ready for real world implementation. Its prone to changes and removal. Please contact our dev team if you need this feature to be moved to higher stability index.
This API is in process of testing and not completely stable. You can start using this, but we cannot guaranty that it will fully function. Additional feature request can be placed for this level of APIs. Please report to us if you find any bugs.
The API has proven satisfactory, but cleanup in the underlying code may cause minor changes. Backwards-compatibility is guaranteed. Additional feature request can be placed for this level of APIs.
This API has been tested extensively in production and is unlikely to change for this version.
Every HTML file in this documentation has a corresponding JSON file with the same data.
This structured JSON output of this documentation is added for the benefit of IDEs and other utilities that wish to do programmatic things with this documentation.