PosTransactionDto specification — field reference for transaction data
A complete field reference for PosTransactionDto, the canonical model for the transaction data ReceiptRoller handles. For each category — identifiers, dates, amounts, line items, payments, staff, status, and CRM linkage — it summarizes the field names, types, meanings, and how each POS vendor populates them. A reference for developers and external-system integrators. Also referenced from the Smaregi and Square mapping articles.
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.
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.
Inventory data integration
Explains the structure of ReceiptRoller's inventory data, multi-warehouse management, stock movement history, real-time sync via Webhooks, and WMS integration patterns.
Ad logs and effectiveness-measurement data
Explains the structure of, and how to retrieve, the campaign, coupon, ad-delivery-log, and purchase-attribution measurement data that ReceiptRoller handles.
Product master (PIM) and category data
Explains the data structure of ReceiptRoller's product master (PIM), categories, and variations, CRUD operations, SKU management, and synchronization patterns with e-commerce.
Ledger and billing-related data (scope of coverage)
Explains the scope of the ledger and billing-related data ReceiptRoller handles, tax reports, qualified-invoice support, and guidance for integrating with accounting software.
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.
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.
ProductDto reference
A complete field reference for ProductDto, ReceiptRoller's product master (PIM). It covers the structure, including catalog sync from a POS (Square), cost price, per-store pricing, variants, and pre-orders.
StaffDto reference
A complete field reference for StaffDto, ReceiptRoller's staff (employee) master. It covers the structure, including the linkage with POS (Square Team / Smaregi), store assignment, and employment type.
What You Can Do with the Developer Portal
An overview of what the ReceiptRoller developer portal lets you do. Combine data retrieval and operations via the REST API with real-time event delivery via Webhooks to connect store and user data from external systems.
Your first API call: from app registration to listing transactions
Get a token with the OAuth authorization code flow and PKCE, confirm the business account, list its transactions, and refresh the token.
CrmCustomerDto reference
A complete field reference for CrmCustomerDto, ReceiptRoller's customer master. Customer information imported from a POS (Smaregi / Square) is normalized into this model.
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.
Webhook overview
Which webhook events are actually sent, what the request and signature headers look like, how duplicates, order and lost events behave, and when to use the API.
Designing resends, ordering, and idempotency
What counts as success, the retry rules (1 min, 10 min, 1 h, four attempts), ordering and lost events, and dropping duplicates by X-RR-Delivery.
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.
Receive new sales by webhook and post them to Slack
Register a receipt.created webhook, verify its signature and drop duplicates in Node.js, and post each new sale to a Slack channel.
Wallet App: Guide to Fetching a User's Receipts via OAuth
Explains how to fetch a user's Receipt Roller purchase receipts, with their consent, from a wallet-style app such as iOS, Android, or a LINE Mini App. Covers OAuth 2.0 authentication, the receipts API, and Webhook integration.