Skip to content

Access permissions

Before using the REST API to access Genstore store data, all apps must declare the required permissions, including predefined CLI access scopes and additional permissions that require approval.

If your app has already configured access scopes via CLI, you can review them in the API access permissions page. However, for sensitive data such as all order data and protected fields, additional approval is required, even if the basic permissions have been declared.

Access scope

ScopeApproval methodDescription
Business domain scopeDeclared by appThe app must declare and be authorized to access specific business data. By default, order data includes only the last 60 days and excludes protected fields. Accessing older data or protected fields requires additional approval.
All order dataRequires approvalAccess to order data beyond 60 days requires a separate application through the partner platform.
Protected fieldsRequires approvalAccess to privacy-sensitive fields requires a separate application through the partner platform.

Request access to all order data

By default, REST API access to order data is limited to the last 60 days. To access older data, approval is required.

Request process

  1. Log in to the Partner Platform.
  2. In the left navigation, go to App.
  3. Select your app to open the details page.
  4. In the left navigation, click API access permissions.
  5. Under Read all order data, click Request access.
  6. Fill out and submit the request form with a justification.
  7. The platform will review your application.

Request access to protected fields

To protect merchant and customer privacy, access to the following protected fields requires approval:

  • Name: First name, last name, or full name
  • Email: User email address
  • Phone: User phone number
  • Address: User's physical address

Request process

  1. Log in to the Partner Platform.
  2. In the left navigation, go to App.
  3. Select your app to open the details page.
  4. In the left navigation, click API access permissions.
  5. Under Protected customer data, click Request access.
  6. Fill out and submit the request form with a justification.
  7. The platform will review your application.