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.
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.
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.
Managing the client ID and client secret
Explains how to obtain the client ID and client secret issued when you register a ReceiptRoller app, storage rules, what to do on a leak, and operating across multiple environments.
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.
SLA, uptime, and the checking procedure during an incident
Explains ReceiptRoller's API uptime targets, how to check the status page, the isolation procedure when an incident occurs, and the flow for escalating to support.
Endpoints and versioning
Explains the base URL of the ReceiptRoller API, the versioning policy, the deprecation-notice flow, and how to check the current version.
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.
Signature verification and security
Explains how ReceiptRoller Webhook HMAC-SHA256 signature verification works, sample verification code (Node.js / Python / C#), replay-attack countermeasures, and how to manage secrets safely.
Error codes and retry guidance
Explains the list of HTTP status codes and error codes the ReceiptRoller API returns, which cases to retry, and guidance on retry intervals.
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.
Webhook is not being delivered
How to isolate the cause when a Webhook does not reach your receiving endpoint. Walks through checking, in order, the endpoint settings, subscribed events, reachability, signature-verification failures, and firewalls.
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.
Access control and audit logs
Explains how to design access control for operating a ReceiptRoller integration app, the principle of least privilege, how to take audit logs, and how to run periodic reviews.
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.
Monitoring and handling failures
Explains how to read the ReceiptRoller Webhook delivery history, the metrics to monitor and how to design alerts, redelivering dead letters, and common failure patterns and recovery procedures.
Rate limiting and throttling
Explains the unit of rate limiting for the ReceiptRoller API, the per-plan limits, how to read the response headers, and implementation patterns to avoid hitting 429.
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.
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.
Receiving Answers to Your Questions
Explains the email notification you receive when someone answers your question, and how to set a best answer.