Developer API Overview
Learn about the Receipt Roller developer API and the steps to get started. Available on Starter plan and above.
Where to Find the API Reference
The list of API endpoints and sample request/response formats are published in the Developer Help.
Registering an OAuth App
Learn how to register an external app that connects to Receipt Roller using OAuth 2.0.
Webhooks and Event Notifications
Learn how to register webhooks and which events ReceiptRoller sends notifications for.
API Keys and Client Secrets
Learn how to issue, manage, and rotate the API keys used for server-to-server integrations.
Store Help Index (Store DX, Digital Receipts, Reservation Management, Retail Media)
This is the ReceiptRoller store help index. It organizes every help article you need for store DX into three categories: customer touchpoints (store app platform, digital receipts, reservation management, retail media including media displays, coupons, CRM, social media management, and AI agent integration), store operations (store data, product management, e-commerce integration, OMS, WMS, shelf analytics, sales analytics, and staff), and account & extensions (getting started, roles and permissions, and the developer API).
Posting to SNS from an AI Agent (MCP Integration)
A guide to posting in natural language to SNS channels connected to ReceiptRoller from AI agents like Claude. Covers drafting posts, posting to multiple channels at once, scheduled posts, and attaching images, all through conversation. Includes concrete phrasing examples and tips.
Self-Service Submission Wizard (App Store / Google Play)
The relay router's store app platform provides a wizard that lets store owners handle native app builds for iOS / Android and submission to the App Store / Google Play entirely from the admin screen. This article covers the wizard flow, required information, asset auto-generation, store operations, and how to track submission status.
Owner Permissions
Details the permissions of the Owner role in ReceiptRoller. Covers plan management, full data access, member management, and per-plan Owner limits.
Square POS Integration Setup
Explains how to connect Square POS with ReceiptRoller. Connect easily via OAuth authentication, and accounting data syncs in real time.
Plans and Roles (Free Plan Limitations)
Explains how ReceiptRoller roles differ depending on your plan. Includes a table showing which roles are available on the Free, Starter, Growth, and Enterprise plans.
Staff Permissions
Details the permissions of the Staff role in ReceiptRoller. The minimum-privilege role for register duty and floor staff, limited to viewing today's transactions and issuing receipts (available on the Free plan).
Square Staff Data and Receipt Roller Staff Data Mapping
Explains how Square Team Members are linked to Receipt Roller's staff data (StaffDto). Covers how to use manual linking, the logic for resolving who is attributed to a transaction, and the key fields in the Team Member API.
What Is ReceiptRoller — An Integrated DX Platform for Retail
ReceiptRoller is an integrated DX platform that unifies digital receipts, CRM, PIM, retail media, SNS management, shelf analytics, and e-commerce integration — everything retail businesses need — into one platform.
Square Transaction Data and Receipt Roller Transaction Data Mapping
A technical explanation of how transaction data fetched from the Square Payment API is mapped into Receipt Roller's transaction data model. Covers the field mapping table, status code conversion, payment method normalization, resolving line items/customer/staff information, OAuth token auto-refresh, and idempotency and timezone handling.
Smaregi Transaction Data and Receipt Roller Transaction Data Mapping
A technical explanation of how transaction data fetched from the Smaregi Platform API is mapped into Receipt Roller's transaction data model. Covers the field mapping table, status code conversion, payment method normalization, resolving line items/customer/staff information, timezone handling, and idempotency.
Square Customer Data and Receipt Roller Customer Data Mapping
Explains how customers registered in Square Customer Directory are converted into Receipt Roller's customer data (CrmCustomerDto), field by field. Covers the given_name / family_name correspondence, address decomposition logic, and how reference_id is handled.
Smaregi Customer Data and Receipt Roller Customer Data Mapping
Explains how Smaregi's customer master is converted into Receipt Roller's customer data (CrmCustomerDto), field by field. Covers the membership number, name, contact info, and date-of-birth correspondence, the priority between mobile and landline numbers, and webhook-based sync timing.
What Is the Store App Platform?
The Store App Platform lets you publish your own branded app across four channels — Web, iOS, Android, and the LINE mini app — for every store. This article covers the overview, available channels, and how to get started.
Overview of Apple Wallet / Google Wallet Membership Cards
The relay router's store app platform can issue your store's original membership card on both Apple Wallet (iPhone) and Google Wallet (Android). This article covers what a Wallet membership card is, the benefits for customers and stores, what's displayed, POS integration, and the setup flow.