API Access
Using the Shopimize API to integrate with external tools.
API access
Shopimize has a read-only API that lets you pull your store's analytics data programmatically — useful if you want to integrate Shopimize data into your own dashboards, scripts, or reporting tools.
Getting an API key
Go to Settings → Security → API Access. Click Generate API Key. Copy and store the key somewhere safe — it's only shown once.
What you can access
The API provides read access to:
- Dashboard summary metrics (revenue, profit, margin for any date range)
- Order-level data with full cost breakdown
- Product performance data
- Cost breakdown by category
Authentication
All requests use Bearer token authentication. Include your API key in the Authorization header:
```
Authorization: Bearer your-api-key-here
```
Rate limits
The API is rate limited to 60 requests per minute per API key. If you exceed this, you'll receive a 429 response. Build in retry logic with exponential backoff for production use.
Documentation
Full API documentation with endpoints, parameters, and example responses is available at docs.shopimize.com.
Revoking a key
If an API key is compromised, go to Settings → Security → API Access and click Revoke next to the key. It stops working immediately. You can generate a new key at any time.
Related Articles
- Product Labels & SegmentationCreate custom product groups based on margin, revenue, or custom rules.
- Commission Rules SetupConfigure payment gateway and marketplace fees per channel.
- Custom Cost TrackingAdd fixed or variable expenses that aren't captured automatically.
- Managing Multiple StoresConnect and switch between multiple stores in one account.
- Data Retention & HistoryHow long Shopimize keeps your data and what happens to it.
- GDPR & Data ExportExport all your data or request account deletion in compliance with GDPR.