Introduce
This is the API documentation of the HugeProfit crm system.
API v2 is available. Webhooks (real-time notifications about sales, products, stock and clients) are provided only in API v2 — see the API v2 documentation.
Settings integration
Image setting:
- Generate a new access token.
- Select your desired sales channel. This sales channel will be displayed in orders and sales in the HugeProfit system.
- Select the appropriate warehouses to which the API will have access.
- Finally, select the warehouse to which the goods will be reserved upon receipt of a new order.
Rate limits
Each API key may make 300 requests per minute. The minute starts with the key's first request, and every request counts, including ones that fail. Every response carries the current state:
| Header | Meaning |
|---|---|
X-RateLimit-Limit |
requests allowed per minute |
X-RateLimit-Remaining |
requests left in the current minute |
X-RateLimit-Reset |
seconds until the counter resets |
Over the limit the API answers HTTP 429 with {"success": false, "error": "rate-limit-exceeded"}
and a Retry-After header (seconds to wait). If your integration needs a higher limit, contact support.