Declaring your purpose of use and connections (POS / e-commerce / analytics, etc.)
For developers who register an app on ReceiptRoller. It explains the meaning of the "purpose of use" and "connection category" declared in the app registration form, how to choose them, and how they appear on the store side.
On ReceiptRoller, you declare a purpose of use and a connection category when registering an app. These help store users understand at a glance "what this app is for", and they are referenced on the authorization screen, the connected-apps list, and during User-scope review.
Why declaration is needed
- A basis for the store user's decision: they can judge "is it OK to hand data to this app" on the authorization screen
- Verifying the scope is appropriate: ReceiptRoller can check whether the purpose and the requested scopes are consistent
- Display by category: it is listed by category in the store's "connected apps"
- User-scope review: for apps handling general users' data, the purpose of use is a key review perspective
- Support and operations: it becomes faster to identify the scope of impact when an incident occurs
Connection categories
At app registration, select one or more of the closest connection categories. If multiple apply, you can select several.
| Category | Expected connections | Scopes mainly used |
|---|---|---|
| POS | Register / POS systems (Smaregi, Square, etc.) | store.read / receipt.write |
| E-commerce | E-commerce sites (Shopify, BASE, makeshop, etc.) | order.read / product.write |
| OMS | Order management systems | order.* / shipment.* |
| WMS | Warehouse / inventory management systems | inventory.* / warehouse.* |
| PIM | Product master management | product.* |
| Analytics (BI) | BI / dashboard tools (Looker, Tableau, etc.) | analytics.read / various *.read |
| CRM | Customer management / MA tools | customer.* / user.profile |
| SNS / advertising | SNS integration / ad delivery tools | sns.* / campaign.* |
| Accounting / billing | Accounting software / invoice-issuing systems | billing.read / receipt.read |
| Wallet / consumer-facing | Consumer-facing receipt management apps, etc. | user.receipts.read (User-scope, review required) |
| Other | Purposes not covered above | Case by case |
If the category and the requested scopes diverge greatly (for example, requesting customer.* while the category is "POS"), a validation warning appears at registration. If it is intentional, supplement the reason in the purpose-of-use description.
Purpose of use (free text)
In addition to selecting a category, write the purpose of use in 200-800 characters. Be sure to include the following three points.
- For whom: for store owners / for store staff / for general consumers / internal only, etc.
- What it does: how the retrieved data is used (sync, display, analysis, delivery, etc.)
- Where it is sent: where the data is stored / processed (your own cloud, a third-party service, an overseas region, etc.)
Example entry (good example)
This app links customer messages sent from the LINE official account operated by the store owner with our own CRM (Salesforce), associating them with past purchase history to improve the quality of responses. Linked data: - Messages and follow events delivered by the LINE Webhook - Purchase history retrieved from ReceiptRoller (receipt.read) Data storage: - AWS in the Tokyo region (self-managed) - No provision to third parties - Retention period is 13 months from the last retrieval; auto-deleted thereafter Scope of use: only owners / store managers of contracted stores. Not disclosed to staff or outside parties.
Example entry (insufficient example)
We provide a service using receipt data.
Because it does not say for whom, for what, or where it is sent, the store side cannot make a judgment. If you request User-scopes, this description alone will not pass review.
Where the declaration is shown
- The OAuth authorization screen: shown as "this app's purpose of use" before the store user presses "Allow"
- The connected-apps list: the "connected apps" section of the store dashboard
- The connected-apps store: for apps that are searchable from other stores, used on the listing page
- User-scope review: a key document the reviewer checks
When you want to change it
You can edit the declaration at any time from the developer portal → App → the "Settings" tab. Note the following, however.
- Changing the category: takes effect immediately. Does not affect users who have already authorized
- Large changes to the purpose of use: if you change important items such as "where the data is sent", "retention period", or "whether there is third-party provision", re-consent from existing users may be required
- If the User-scope is already reviewed: changing the intent of the purpose of use triggers a re-review
Additional information when using User-scopes
For apps handling general consumers' data (user.receipts.read, etc.), in addition to the purpose of use, you are asked to submit the following information.
- The privacy policy URL (must be published)
- The terms of service URL (optional)
- A deletion-request contact (email address or form URL)
- The data retention period and deletion policy
- Whether there is third-party provision, and the recipient
- If a test account is needed for review, prepare it
Without these, the User-scope review will not pass, or will not even proceed to the start of review. See the next article, "Applying for review of User-scopes", for details.
Frequently asked questions
Q. My app fits multiple categories. Should I select them all?
A. Narrow it to the closely related ones. About 3 is a good guideline. Rather than selecting comprehensively, clearly indicating the primary purpose makes it easier to earn trust from stores.
Q. In early development, the purpose is not fixed. Can I register tentatively?
A. For a development app (a separate, non-production app), a tentative description is fine. But for the production app, make the description match the actual purpose.
Q. May I write the purpose of use in English?
A. Match the region where the authorization screen is shown. Japanese for Japanese stores; English recommended for overseas. You can also write it bilingually.
Q. Can anyone see the declaration?
A. Because it is shown on the authorization screen and the connected-apps list, users who authorize can see it. If you publish it to the connected-apps store, anyone can view it. Do not write internal confidential information in it.
Related guides
-
Setting the redirect URLExplains the role of the redirect URI (callback URL) you set in the ReceiptRoller developer portal, the registration rules, using development vs. production environments, and common errors and how to handle them.
-
Applying for review of User-scopesFor 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.
-
Managing the client ID and client secretExplains 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.