API reference

Error shapes

Two error shapes. Key off HTTP status and message — both are always present.

Most B2C failures are thrown errors. They bypass the ResponseModel envelope. A handful of paths return a response object instead and keep the envelope. A client should not assume data or timeStamp exist on failure.

Response

200

{
  "message": "Entity Not Found",
  "error": {
    "errorMessage": "Entity Not Found",
    "details": null
  }
}

Shape A — thrown errors

Ownership 404s, permission 403s, and provider/validation errors inside a delegated handler. No data, no timeStamp.

Shape B — returned errors

Keeps the ResponseModel envelope. error is an ErrorCompact: status, errorMessage, localizedMessage, cause, details. Produced by GET /v2/order/show/{id} (not-found) and by login / me (forbidden / not-found / validation).

Ownership and 404

Every endpoint that takes a cart or order id answers 404, never 403, when the resource belongs to another customer. A missing resource and someone else’s resource are indistinguishable.