Overview

Campaigns API is a headless API for developers to easily create complex external checkout flows using javascript, no backend server-side integration required.

Before using the Campaigns API, you'll need to install the Campaigns App on your store and create a campaign to retrieve your API Key.

Authentication

Campaigns API uses unique API Keys for authentication to access campaign details and execute the checkout flow with your configured packages.

Rate Limiting

Campaign APIs are rate-limited to maintain the stability for all users. We employ a number of methods to enforce rate limits including API Keys and IP Address.

Identifier	Rate Limit Method	Limit
IP Address	Request-based	4 requests/second

Sample

The following sample shows the API response for the status code 429.

HTTP/1.1 429 Too Many Requests
Retry-After: 1

Why Rate Limits?

Rate limiting is required to prevent the network and application services from becoming overloaded.

Setting a rate limit helps to prevent API abuse and provide overall fairness of use across the platform.