Rate limits

How the limit works

Every installation of your app (your app on one store) has its own bucket of 40 requests. Each API call adds one request to the bucket, and the bucket leaks 2 requests a second.

You can make up to 40 calls in a burst.
After that you can keep going at 2 calls a second (120 a minute).
A call that would overflow the bucket is refused with 429 Too Many Requests.

The bucket belongs to the installation, not to your app as a whole. Calls on one store never use up your budget on another store, and another app on the same store has its own bucket.

This limit applies to calls made with an app_ token. A few actions have their own daily or hourly caps on top of it: sending a notification (5 a day) and sending email (10 requests an hour). A call has to fit both.

Read the call limit header

Every response to your app, a 429 included, carries:

X-Salesive-Api-Call-Limit: 32/40

The first number is how full your bucket is after this call, the second is its size. When the first number gets close to the second, slow down.

When you get a 429

HTTP/1.1 429 Too Many Requests
Retry-After: 1
X-Salesive-Api-Call-Limit: 40/40

{
  "status": 429,
  "success": false,
  "message": "This app has exceeded the API rate limit for this store. Retry after 1 second(s).",
  "data": { "limit": 40, "leakPerSecond": 2, "retryAfter": 1 }
}

Retry-After is the number of whole seconds until there is room for one more call. Wait that long, then retry. A refused call did nothing: it is safe to send again, and it never triggers a webhook.

Staying under the limit

Use webhooks instead of polling. Let Salesive tell you when something changed, then fetch just that record. See Webhooks.
Pace bulk work. If you need to page through a large list, aim for about 2 calls a second per store instead of firing everything at once.
Retry with the header, not a fixed sleep. Read Retry-After and wait at least that long.

async function callSalesive(url, token, attempt = 0) {
  const res = await fetch(url, { headers: { Authorization: `Bearer ${token}` } });
  if (res.status === 429 && attempt < 5) {
    const wait = Number(res.headers.get("retry-after") || 1);
    await new Promise((r) => setTimeout(r, wait * 1000));
    return callSalesive(url, token, attempt + 1);
  }
  return res;
}

Overview

Billing

Blogs

Categories

Comments

Customers

Digital access

Digital products

Discounts

Domains

Emails

Foods

KYC

Notes

Notifications

Orders

Payouts

Products

Roles

Scripts

Services

Shipday

Shipping

Tasks

How the limit works

Read the call limit header

When you get a 429

Staying under the limit

​How the limit works

​Read the call limit header

​When you get a 429

​Staying under the limit

How the limit works

Read the call limit header

When you get a 429

Staying under the limit