Skip to main content
Welcome to the Blink API! Our suite of APIs provides everything you need to build, manage, and scale your storefront programmatically.

Blink API

The main server-to-server API for merchants to manage checkouts, products, and store settings.

Shopper API

Customer-token authenticated endpoints used to power customer-facing dashboards.

Growth API

Marketing, affiliates, abandoned carts, and upselling tools.

Webhooks & Events

Event tracking, webhook management, and store analytics.

​
Base URLs

The Blink API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Production Base URL

https://api.blink.store/v1

Sandbox Base URL

https://sandbox-api.blink.store/v1
Note on Sandbox: The sandbox environment is fully isolated—data, users, tokens, and organizations created there do not affect production. Create separate tokens in each environment.

​
Authentication

Blink uses different types of authentication tokens depending on the API you are accessing. For server-to-server interactions, authenticate requests using your Store Secret Key. You can view and manage your API keys in the Blink Dashboard. Do not share your secret API keys in publicly accessible areas such as GitHub, or client-side code. Authentication to the API is performed via HTTP Bearer Auth. 
Authorization: Bearer blink_live_xxxxxxxxxxxxxxxxxxxxxxxxxxx

​
Customer Tokens (Shopper API)

For the Shopper API, you authenticate using a temporary Customer Token granted when a shopper logs into their customer portal. This token only grants access to data owned by that specific customer. 
Authorization: Bearer cus_xxxxxxxxxxxxxxxxxxxxxxxxxxx
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
It’s important to use the correct API and token for your use-case.
FeatureBlink APIShopper API
AuthenticationMerchant Secret Key (blink_live_...)Customer Token (cus_...)
Use CaseServer-side logic, admin dashboards, syncing data.Client-side customer portals, mobile apps for buyers.
PermissionsFull read/write access to your entire store.Read/write access strictly limited to a single customer.
Rate Limits100 req / sec20 req / sec

​
Pagination

All top-level API resources have support for bulk fetches via “list” API methods. These list API methods share a common pagination structure. Blink uses offset-based pagination via the page and limit query parameters.

​
Query Parameters

ParameterTypeDefaultDescription
pageinteger1The page number to retrieve.
limitinteger50The number of items to return per page. Max 100.

​
Response Format

A paginated response will always wrap the results in a data array and include a meta object containing pagination details.
Paginated Response
{
  "meta": {
    "total": 1240,
    "page": 1,
    "limit": 50,
    "has_more": true
  },
  "data": [
    {
      "id": "ord_123",
      "amount": 5000,
      "status": "paid"
    }
  ]
}

​
Rate Limits

To prevent abuse, Blink limits the number of API requests you can make in a given timeframe.
  • Production: 100 requests per second
  • Sandbox: 50 requests per second
If you exceed these limits, the API will return a 429 Too Many Requests status code. 
{
  "error": "rate_limit_exceeded",
  "message": "You have exceeded the rate limit of 100 requests per second."
}