Available data domains

ReceiptRoller is a platform that manages the retail data stores and brands handle in one cross-cutting place. From the developer portal, you can integrate the following data domains via the REST API and Webhook, depending on your purpose.

Retrieving each domain requires the corresponding OAuth scopes. For the complete list of scopes and retrieval restrictions, see OAuth scopes reference and availability.

1. Transaction and receipt data

Transactions that occur through a POS, e-commerce, or your own app, and the digital receipt data tied to them. This is the most frequently handled core data in ReceiptRoller.

• Main data included — transaction ID, store ID, transaction date/time, subtotal / tax / total, payment method, line items (product name, quantity, unit price, tax category), discount application info, receipt issuance status (issued, refunded, voided)
• Retrieval methods — API (reading transaction history, retrieving a specific transaction) / Webhook (real-time notification of issuance and update events)
• Required scopes — from the store side, store.orders.*; from the user side, user.receipts.read (review required)
• Main use cases — receipt integration to your own server, viewing receipts in a wallet app, auto-import into a household-budget app

2. Product data (PIM)

The product master a store handles, plus the attributes, categories, and variation info tied to products. This corresponds to Product Information Management.

• Main data included — product ID, SKU, JAN code, product name, description, price, tax category, category, attributes (size, color, etc.), variations, image URLs, publication status
• Retrieval methods — API (list, individual, create, update, delete), CSV bulk import / export
• Required scopes — store.products.read / store.products.write
• Main use cases — two-way sync with an external product master system, product-info integration with e-commerce, bulk updates from an internal CMS

3. Inventory data

Product stock counts and transaction data such as receipts, issues, and stocktakes. Supports WMS integration and multi-location inventory management.

• Main data included — product ID, store ID, location, current stock count, reserved stock, expected incoming count, receipt/issue history
• Retrieval methods — API (read stock, adjust stock)
• Required scopes — store.inventory.read
• Main use cases — stock sync with an external WMS, showing stock counts on an e-commerce site, managing stock transfers between stores

4. Order data

Orders that occur through e-commerce, reservations, in-store orders, etc., and status changes such as shipment and cancellation.

• Main data included — order ID, order date/time, customer ID, shipping destination, order line items, order status (unconfirmed, confirmed, shipped, cancelled), payment status
• Retrieval methods — API (order list, detail, status update) / Webhook (order created, status change events)
• Required scopes — store.orders.read / store.orders.write
• Main use cases — OMS integration, shipping instructions to your own delivery system, an order dashboard

5. Customer data / CRM

The customer profiles the store holds, segments based on purchase history, loyalty rank, and other CRM data.

• Main data included — customer ID, basic attributes (name, email, phone, address), purchase history summary, last-visit date, purchase frequency, cumulative purchase amount, segment (VIP, regular, etc.), rank
• Retrieval methods — API (customer list, detail, segment definition)
• Required scopes — store.customers.read; for CRM segments, crm.profiles.read / crm.segments.read
• Main use cases — customer sync with an external MA tool, segment analysis in your own BI, preparing targeted delivery

6. Coupon and promotion data

Coupons a store issues, promotion settings, delivery results, usage results, and other promotion-related data.

• Main data included — coupon ID, name, discount type (percent / fixed amount), discount value, validity period, max usage count, delivery status, usage count, the transactions it was applied to
• Retrieval methods — API (create, update, read coupons)
• Required scopes — store.coupons.read / store.coupons.write
• Main use cases — bulk coupon issuance from a marketing tool, delivery-effectiveness report integration, unification with an external coupon system

7. Store and business account data

A store's basic info, business hours, address, contact, the list of stores under a business account, and so on. Needed when the integration app performs per-store settings or display.

• Main data included — store ID, store name, address, phone number, business hours, store type, business account ID, store status (open, closed, etc.)
• Retrieval methods — API (store list, detail)
• Required scopes — readable with a Store-scope if the connected store is authorized
• Main use cases — showing a store list in your own UI, automatic control based on business hours, per-store report generation

8. Store flyer data

The metadata and content of digital flyers a store publishes. Handles both automatic scraper collection and manual uploads by store staff in a unified data model.

• Main data included — flyer ID, store ID, title, validity period, PDF/image URL, OCR-extracted text, AI summary, category, publication status
• Retrieval methods — API (flyer list, detail, create, update)
• Required scopes — store.flyers.read / store.flyers.write
• Main use cases — flyer display in your own app, a flyer comparison service, product search using AI summaries

9. SNS and analytics data

Posts, audience, and performance data retrieved through a store's SNS account integration, and various analytics snapshots of store operations.

• Main data included — SNS post ID, publication date/time, body, media URLs, platform, engagement (likes, comments, reach), audience attributes (age, gender, region), analytics snapshots (sales, footfall, campaign effectiveness)
• Retrieval methods — API (post list, reading analytics data)
• Required scopes — sns.content.read / sns.audience.read / analytics.read
• Main use cases — SNS performance integration into an internal BI, cross-store reports over multiple stores, optimizing campaigns using analytics data

10. Retail media (ad log) data

Delivery results and effectiveness-measurement data for ads shown on in-store digital signage and on digital receipts.

• Main data included — ad campaign ID, delivery device ID, delivery date/time, impression count, clicks, conversions (linkage to transactions), revenue summary
• Retrieval methods — API (reading delivery logs and revenue reports)
• Required scopes — analytics.read (retail-media-specific scopes are being added progressively)
• Main use cases — reports for advertisers, integration with a revenue-management tool, an effectiveness-measurement dashboard

11. Individual user data (review required)

Data that an individual user with a ReceiptRoller account can share with their own consent. Used from household-budget apps, wallet apps, and consumer-facing services.

• Main data included — user basic info, all received receipts (across multiple stores), monthly spending summary, spending by category, favorite stores, obtained coupons
• Retrieval methods — API (OAuth 2.0 authorization code flow, user consent required)
• Required scopes — user.profile.* / user.receipts.read / user.spending.* / user.coupons.read / user.favorites.*
• Main use cases — wallet-type mobile apps, household-budget apps, automatic bookkeeping of household spending, coupon push notifications for favorite stores

12. Survey data

Survey campaigns a store runs, and the response data. Responses are collected through paths such as QR codes, URLs, and receipt embeds.

• Main data included — campaign ID, public URL token, questions, response data, response date/time, response path (QR, link, receipt embed), linked coupon
• Retrieval methods — Survey API (public endpoints, response submission, distribution-target settings)
• Required scopes — management from the store side is planned. The response-submission public API is token-based
• Main use cases — post-visit NPS surveys, post-purchase satisfaction surveys, granting incentives for responses
• Related guide — Survey API and receipt embed

Summary of retrieval methods

Examples of combining data domains

In real services, you often combine data from multiple domains. Here are some representative examples.

• Your own POS integration app — transaction data (Webhook receive) + product data (sync) + inventory data (update)
• Household-budget mobile app — individual user receipts + monthly spending summary + coupons for favorite stores
• Store marketing tool — customer / CRM data + transaction history + coupon delivery + effectiveness measurement (analytics)
• Product comparison / flyer app — store flyers + product data + store data
• Advertiser dashboard — retail-media delivery logs + transaction data (conversion linkage) + audience attributes

Related guides

• What you can do in the developer portal (API and Webhook)
• OAuth scopes reference and availability
• Guide for stores: issuing digital receipts and notifying via Webhook from your own app
• Guide for wallet apps: retrieving a user's receipts via OAuth
• Back to the developer help index