Skip to main content

Customer API

Request parameters should be passed as a part of a URL or a request body.

Request and response bodies are in JSON format by default.

API response could have the following HTTP status codes:

  • 200 - request processed by a server
  • 404 - endpoint not found or HTTP method not supported

200 status​

If no error occurred while request processing then the following JSON is returned:

{
  "value": ...
}

The value field can be an object, string, number or any other JSON valid value. If an API endpoint doesn’t suppose to return any value then this field will be absent in a response body.

If an error occurred then the following JSON is returned:

{
  "error": {
    "code": required string,
    ... additional error fields (depends on endpoint and error code)
  }
}

404 status​

No response body is returned with this status.