API documentation | Retail media data integration guide

API catalog

APIs for every part of the platform: purchases, advertising, CRM, AI, e-commerce and store operations.
Filter by category or audience to find the API you need.

For stores

Purchase data API

Get digital receipts, sales and purchase history for sales analysis and CRM.

Details →

For consumers

User receipts API

Get and save an end user's receipts, with AI receipt scanning and monthly spending summaries.

Details →

For consumers

Favorite stores API

List, add and remove an end user's favorite stores.

Details →

For consumers

User coupons API

Get the coupons, with details, from an end user's favorite stores.

Details →

For advertisers

Ad submission API

Submit ads to signage, digital receipt, printed receipt and app ad spaces, including ads with coupons.

Details →

For marketers

Coupons and campaigns API

Issue and distribute coupons and track redemptions, linked automatically to purchase history.

Details →

For agencies and creators

Creatives API

Upload image and video creatives. Size, orientation and length are checked for each ad space when you submit.

Details →

For advertisers and agencies

Campaign management API

Create campaigns, target them by area, business type, store, time of day and purchases, and submit them for review. Agencies can work on behalf of linked clients.

Details →

For marketing analysts

Ad reporting API

Get impressions, clicks, spend and coupon redemptions by day and by store, plus sales lift for each campaign.

Details →

For media companies

Content channels API

Add images and videos such as news and weather from your own systems and show them on store signage. Feeds can be imported automatically.

Details →

For brands and stores

Customers and CRM API

Get customer attributes, buying patterns and lifetime value for segment marketing.

Details →

For developers

AI forecasting API

Forecast sales, demand and churn to optimize ordering and ad delivery automatically.

Details →

For developers

OCR and image analysis API

Read receipts and shelf photos to extract product names and prices.

Details →

For stores

Shelves and display API

Monitor shelf stock and facings, and detect out-of-stocks automatically.

Details →

For stores

Product management (PIM) API

Search, create and update the product master. Price changes are sent to Shopify automatically.

Details →

For stores

Order management (OMS) API

Confirm, process, ship and cancel orders, and link them to POS transactions.

Details →

For stores

Inventory management (WMS) API

Look up, adjust and move stock by location, with two-way sync to Shopify inventory.

Details →

All services

Authentication and access API

Get OAuth 2.0 tokens, the access foundation for every API.

Details →

Integrations

Webhooks API

Send events such as purchases, ad activity and stock updates to outside systems in real time.

Details →

Shared infrastructure

Master data API

Sync store, staff and product masters with outside systems and connect them to POS and CRM.

Details →

Authentication and access

The API requires authentication with the OAuth 2.0 authorization code flow.
Once a developer registers an app and a business owner grants access, you can get a token and call the API.

1. Get an authorization code

GET /oauth/authorize
  ?client_id=YOUR_CLIENT_ID
  &redirect_uri=YOUR_REDIRECT_URI
  &response_type=code
  &scope=store.products.read
  &state=RANDOM_STATE

→ The business owner approves on the consent screen
→ redirect_uri?code=AUTH_CODE

2. Exchange the code for a token

POST /api/v1/auth/token
Content-Type: application/json

{
  "grantType": "authorization_code",
  "clientId": "YOUR_CLIENT_ID",
  "clientSecret": "YOUR_SECRET",
  "code": "AUTH_CODE",
  "redirectUri": "YOUR_REDIRECT_URI"
}

→ Returns accessToken + refreshToken

Send the token in the request header: Authorization: Bearer {access_token}

Authentication and access API details

Example request

Here's an example that gets purchase data. It returns product names, prices, the store and the time of purchase.

GET /api/v1/store/receipts/{id}
Authorization: Bearer {access_token}

{
  "store": "Example Store",
  "total": 842,
  "items": [
    { "name": "Coffee (M)", "price": 180 },
    { "name": "Sandwich", "price": 420 }
  ],
  "timestamp": "2025-11-11T10:32:45Z"
}

See every endpoint (API reference)

OpenAPI specification (machine-readable)

Every endpoint is published in OpenAPI (Swagger) format.
Give this URL to an AI coding assistant or a code generator to get a typed API client.

https://receiptroller.io/openapi/v1.json

Open openapi/v1.json API reference

Real-time integration with webhooks

When an event such as a purchase or an ad click happens, we notify the URL you set in real time.
Use it to connect promotion apps and in-house analytics automatically.

POST /webhook/purchase
{
  "event": "purchase.completed",
  "receipt_id": "rcp-8421093",
  "total": 842,
  "timestamp": "2025-11-11T10:32:45Z"
}

Support and contact

For API sign-up, technical integration or commercial use, contact us through the form below.

Go to the contact form