About this documentation

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,

  • Introduction
  • Endpoint
  • Request Parameters
  • Example Request
  • Response Parameters
  • Example Response
  • Possible Errors
  • Success Code

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.

Stability Index

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.

JSON Output

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.