Main Concepts

Overview

WSHOP API is a REST API — not RESTful. Rather than exposing generic resource endpoints driven purely by HTTP verbs, every operation has an explicit action in the URL. This makes intent unambiguous: the URL tells you exactly what is happening without relying on convention.

HTTP verbs and permissions

The HTTP verb is not used to determine the operation — the action in the URL does that. Please refer to the documentation of each endpoint for details on the expected verb(s).

Every API user is associated with a profile in the WSHOP Back Office. That profile controls which resources and permission levels are accessible.

Request format

All parameters are passed as a JSON body. The Content-Type of every request must be application/json. Parameters are always optional unless explicitly documented otherwise for a given endpoint.

Parameters are always optional unless explicitly documented otherwise for a given endpoint.

Response envelope

Every response wraps its payload in a consistent envelope:

Success:

{
  "success": true,
  "data": [ ... ]
}

Error:

{
  "success": false,
  "error": {
    "message": "Description of the error"
  }
}

The success field is always present and is the primary way to determine whether a call succeeded.

Error reference

The /api/v1/errors/get endpoint returns the full list of all documented error messages across all resources. This is useful for building error handling logic or translating error codes on your side.