Developer Help Index
API
OAuth
Webhook
authentication
scope
Developer Help
ReceiptRoller's developer portal lets you connect retail data — purchases, sales, advertising, inventory, and more — via the REST API and Webhooks. If you're registered as a store user on the Starter plan or above, you can start registering an app and implementing the API right away, with no separate developer application.
Getting started
- What you can do with the developer portal (API and Webhooks)
- Available data domains (purchases, products, inventory, ad logs, and more)
- Steps to get started (register a store → Starter plan → register an app)
- How to read the API reference and documentation
App registration
- What app registration is
- Creating a new app
- Setting the redirect URL
- Declaring your purpose and integration target (POS / e-commerce / analytics, etc.)
- Applying for User scope review
Authentication and credentials
- API authentication guide (OAuth 2.0 authorization code flow)
- OAuth scopes reference and availability
- Managing the client ID and client secret
- Obtaining and refreshing an access token
- Secret rotation and secure storage
Implementation guides (by use case)
- Wallet app: guide to fetching a user's receipts via OAuth
- Store-facing: guide to issuing digital receipts from your own app and notifying via Webhook
- Native mobile app: multi-business-account access and the OAuth flow
- Listing business accounts, stores, and POS terminals
- Using the Sales API
- Using the Products API
- Using the Orders / OMS API
- Using the Inventory / WMS API
- Using the Staff API
- Using the Business Hours API
- Using the Store Information API (read and update)
- Using the Reservations API
- Using the Transactions API (unified POS + OMS feed)
- Using the Store App Content API (announcements, pages, business info)
- Survey API and receipt embed
API basics
- Endpoints and versioning
- Request and response basics (JSON)
- Representative API examples (fetching receipts, etc.)
- Error codes and retry guidance
- Rate limits and throttling
Guides by data domain
- Purchase / receipt data integration
- Product master (PIM) and category data
- Inventory data integration
- Ad log and attribution data
- Billing and invoice-related data (scope of support)
Webhooks (event integration)
- Webhook overview (purchase events, etc.)
- How to register a Webhook
- Signature verification and security
- Designing for retries, ordering, and idempotency
- Monitoring and handling failures
- SNS Webhook bypass (forwarding Webhooks from external SNS such as LINE)
Operations and security
- Approaches to data protection (anonymization and encryption)
- Access control and audit logs
- Best practices for production operation
- SLA, uptime, and steps to check during an incident
Community
Troubleshooting
Published: 2026-03-05
Updated: 2026-07-05
Category
Tags
API (22)
OAuth (16)
Android (11)
iOS (9)
Webhook (5)
App registration (4)
POS Integration (4)
Reference (4)
Troubleshooting (4)
api (4)
Related articles
-
Using the Store Information APIA guide to the REST API for fetching and updating a store's basic information (store name, store type, contact details, and address). Lets you implement a store information editing screen from token-authenticated clients such as staff apps.
-
Purchase and receipt data integrationExplains the structure of the purchase and receipt data ReceiptRoller handles, how to retrieve it, related scopes, Webhooks, and common use cases.
-
PosTransactionDto specification — field reference for transaction dataA 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.
-
Using the Orders / OMS APIA guide to CRUD operations on the orders under a business account using ReceiptRoller's Orders / OMS API (/api/v1/orders). Covers creating, updating, transitioning status (confirm, process, cancel), and deleting orders, plus the flow for Android / iOS apps and server integrations.
-
Using the Business Hours APIA guide to ReceiptRoller's Business Hours API (/api/v1/stores/{storeId}/business-hours). Covers retrieving and updating per-day business hours, registering special business days (temporary closures and hour changes), configuring a store's workable hours (the upper bound for shift creation), and determining whether the store is currently open.