API Reference

Complete reference for every MultiCartAPI endpoint. All requests go to the base URL below and authenticate with your API key. Pick a resource from the left, or read the essentials first.

Authentication

Every authenticated endpoint accepts either of two interchangeable credentials. Send your API key as x-api-key, or a dashboard session token as Authorization: Token …. A handful of read-only endpoints (listing domains, Officeworks stores, and public plans) need no authentication at all.

The response envelope

Every endpoint returns HTTP 200 wrapped in a consistent envelope. Branch on status (1 = success, 0 = failure) rather than the HTTP status code; the intended HTTP code is carried in code.

{
  "code": 200,        // intended HTTP code
  "data": { ... },    // payload on success, or an error message on failure
  "status": 1         // 1 = success, 0 = failure
}

Response codes

Resources