Overview

How the Roqstar API works: base URL, authentication, and the JSON response format.

API access (coming soon). The seller API is not available yet. The pages below are a preview. Contact support if you need early access.

The Roqstar API lets you read and manage your store data products, orders, customers from your own tools and automations. It returns JSON over HTTPS.

Base URL

Requests go to your own store domain, under /api/: for example https://yourdomain.com/api/.

Authentication

You sign in once to receive an access token, then send it on every request in the Authorization: Bearer <token> header. Treat this token like a password anyone who has it can act on your account.

Response format

  • Success: a JSON object containing your data, with "success": true.
  • Errors: "success": false plus a short error message and a matching HTTP status (for example 401 when the token is missing or expired).
Example JSON success response in a REST client.
An example 200 response with a JSON body in a REST client.