Resources

WareRushAI public REST API (read-only)

Read your products, stock, orders, missing data and marketplace errors from Zapier, Make, n8n or your own code with an API key. OpenAPI 3.1 description included.

Revised:

1. What it is

The WareRushAI REST API lets other programs read the data of one company: products, stock per location, orders, products with missing data and marketplace listing errors. It is read-only in this version and sits on top of the same services and permission checks as the web app and the MCP connector. The base address is https://app.warerushai.com/api/v1. The API is being opened gradually: until it is switched on for the platform, every call returns 404 and no keys can be created.

2. Create an API key

An owner or administrator opens Settings, then Integrations, then API keys, names the key, picks the permissions (catalog.read, inventory.read, orders.read, account.read), an expiry and a per-minute limit, and creates it. The full key starts with wra_live_ and is shown only once. WareRushAI stores only a one-way hash and the first characters, so a lost key cannot be recovered: create a new one. You can revoke a key at any time, or rotate it: the new key is shown once and the old one keeps working for 24 hours.

3. Authenticate

Send the key in the Authorization header: Authorization: Bearer wra_live_... over HTTPS. Never put the key in the web address; a request that does so is rejected with key_in_url. Example: curl -H "Authorization: Bearer $WRA_KEY" "https://app.warerushai.com/api/v1/products?limit=20". OAuth 2.1 access tokens of the MCP connector are accepted as well, with the permissions the user approved.

4. Endpoints

GET /me (the key, its limits and today's usage), GET /products (search and list, with query, limit, cursor), GET /products/{id}, GET /locations, GET /inventory (stock lines, paginated), GET /inventory/summary, GET /orders (with updated_since, status, source, limit, cursor), GET /missing-data and GET /marketplace-errors (with channel). Every endpoint needs the matching permission: catalog.read for products, missing data and marketplace errors, inventory.read for locations and inventory, orders.read for orders. Only GET is supported; other methods return 405.

5. Pagination and polling

Lists return data, next_cursor and has_more, with at most 50 items per page (limit 1 to 50, default 20). Pass next_cursor back as cursor to get the next page. For Zapier, Make and n8n polling triggers call GET /orders?updated_since=2026-11-15T08:00:00Z and remember the time of your last successful poll: you get the orders created or changed since then, newest first.

6. Limits and errors

Each key has a per-minute limit (default 60, at most 600) and an optional daily limit. Each company also has a daily allowance by plan: by default 1 000 calls for Starter, 10 000 for Business and 100 000 for Pro. When a limit is reached the API answers 429 with a Retry-After header. Headers X-RateLimit-Limit, X-RateLimit-Remaining, X-Daily-Limit and X-Daily-Remaining show what is left. Errors always look like {"error":{"code","message","request_id"}}; quote the request_id when you contact support. Common codes: invalid_api_key (401), insufficient_scope (403), not_found (404), invalid_parameter (400), rate_limited and daily_quota_exceeded (429).

7. OpenAPI description

The machine-readable OpenAPI 3.1 description is at https://app.warerushai.com/api/v1/openapi.json and needs no key. Import it into Postman, Zapier, Make, n8n or an AI assistant to get all endpoints, parameters and response shapes. Changes are made without breaking existing fields; the version is /api/v1.

8. Security

Keys belong to exactly one company and are checked on every call; a key can never read another company, and it stops working if the administrator who created it leaves the company. Keys never appear in logs or error messages, and the call log shows only the path, status and time. Financial data such as purchase prices is not exposed by this API.