Declaring your purpose of use and connections (POS / e-commerce / analytics, etc.)
Explains the meaning of the "purpose of use" and "connection category" (POS / e-commerce / analytics / CRM / OMS / WMS / SNS / other) declared when registering an app in the ReceiptRoller developer portal, how to choose them, cautions when changing them, and the relationship to User-scope review.
Applying for review of User-scopes
For apps that handle general consumers' data (user.* scopes) on ReceiptRoller, this explains the review application flow, the documents to submit, the review criteria, the review period, and common reasons for rejection.
How to read the API reference and docs
Explains the structure of ReceiptRoller's developer documentation and when to use each part. Covers the four entry points — the developer help, the API top page, the Swagger-based API reference, and the developer community — and how to obtain the OpenAPI spec (openapi/v1.json) for use with AI assistants and code generators.
Webhook overview
Explains the main event types delivered by ReceiptRoller Webhooks, why to use Webhooks instead of polling, the delivery format (HTTPS POST + JSON), and how to think about delivery guarantees.
OAuth Scopes Reference and Availability
A reference of all scopes available in the ReceiptRoller OAuth API and which kinds of apps each scope can be granted to. Also covers the review requirement for User scopes, why Store and User scopes can't be mixed, and how to use the API from a LIFF app.
What is application registration
Explains the concept of ReceiptRoller application registration. Registering an app as an OAuth client issues a client ID, secret, and redirect URI, letting you start API and Webhook integrations.
Purchase and receipt data integration
Explains the structure of the purchase and receipt data ReceiptRoller handles, how to retrieve it, related scopes, Webhooks, and common use cases.
SNS Webhook bypass (forwarding Webhooks from external SNS such as LINE)
Explains the mechanism, setup, signature handling, and cautions of the "SNS Webhook bypass" feature, which forwards Webhooks ReceiptRoller receives from SNS platforms such as LINE to a developer app, with the store's consent.
How to register a Webhook
Explains how to register a Webhook endpoint in the ReceiptRoller developer portal, how to choose subscribed events, test delivery, using multiple endpoints, and how to delete or pause an endpoint.
Using the in-store media display API (Display API)
An overview of ReceiptRoller's in-store Android display API (/api/v1/displays/*) and the steps for pairing, heartbeat, playlist retrieval, and impression reporting. An introductory guide for building an app that plays a media loop on an Android kiosk or in-store signage device.
Available data domains
A one-page overview of the data domains you can retrieve from the ReceiptRoller developer portal. Summarizes the contents, retrieval methods, and required scopes for each domain — transactions, products, inventory, orders, customers, coupons, SNS, advertising, individual user data, and more.
Using the Sales API
An overview of ReceiptRoller's Sales API (/api/v1/sales/*) and how to filter by business account, store, POS terminal, and period. A getting-started guide covering the actual response structure (the KpiValue nested type) through averageTicket and the 8-hour token lifetime, for building a sales dashboard in an Android/iOS mobile app or server integration.
Using the Transactions API (POS + OMS unified feed)
ReceiptRoller's Transactions API is a read-only API that unifies register sales (PosTransactions) and order-management orders (OmsOrders) into a single feed. It is the entry point for showing "all of a business account's transactions" as a list in an Android / iOS app.
Creating a new app
Explains the concrete steps to register a new app (OAuth client) in the ReceiptRoller developer portal. Covers the input fields, validation, the post-creation credentials display, and common errors.
The basics of requests and responses (JSON)
Explains the request format, required headers, response structure, pagination, filtering, and date/time format rules of the ReceiptRoller API.
How to think about data protection (anonymization and encryption)
Explains how to think about data protection in a ReceiptRoller integration app — encryption (at rest and in transit), anonymization and pseudonymization techniques, and a deletion policy.
Rotating and safely storing secrets
Explains the rotation plan for safely operating ReceiptRoller client secrets and Webhook secrets, how to use the old/new parallel period, and best practices for storage.
Representative API examples
Introduces, as curl commands, examples of calling the representative ReceiptRoller API endpoints (retrieving receipts, listing stores, creating products, registering Webhooks).
Using the Products API
A guide to CRUD operations on products under a business account using the ReceiptRoller Products API (/api/v1/products). An introductory article for reading and writing the PIM (product master) from an Android/iOS app or server integration.
Developer Help Index
The index of ReceiptRoller developer help. Covers the developer application, app registration, OAuth authentication and scopes, implementation guides (wallet apps, store-facing Webhooks, the Survey API), guides by data domain, operations and security, the community, and troubleshooting.