English

简体中文

English

简体中文

Appearance

About App ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Genstore supports both platform-built and third-party applications. These applications extend Genstore's core features to enhance merchant operations. Using Genstore's open APIs and tools, developers can build new features or integrate external services.

The application module manages Genstore applications. It provides data statistics and state synchronization through REST APIs and Webhooks.

Core Features

  • Event System: Webhook-based notification system for application lifecycle events.
  • Monitoring System: APIs for application performance and health monitoring.

Use Cases

  • Application State Sync: Applications can subscribe to the Application Installation topic (app/installed) to handle pre-processing during merchant installation.
  • Application Statistics: Developers can monitor application health status using the application statistics API.

Endpoints

EVENT app/scopesUpdate: app scopes update

EVENT app/uninstalled: app uninstalled

App Object ​

An application object is the application instance data that the application generates when it is installed by a business.

Properties ​

appobject
app install information.
- Hide child properties
clientIdstring
Application's client ID.
shopIdnumber
Unique identifier for the current shop.
bash
{
  "app": {
    "clientId": "58DAED6AEC7AA1C2C8DFD719E8E06E3A",
    "shopId": "4022054969604"
  }
}

EVENT app scopes update ​

Occurs whenever the access scopes of any installation are modified. Allows apps to keep track of the granted access scopes of their installations.

Access scope

Requires ANY of the following access scopes: write_apps read_apps

Topic

EVENT app/scopesUpdate 

Event Data

authScopeobject
Authorize access to scope information.
- Hide child properties
clientIdstring
Application's client ID.
shopIdnumber
Unique identifier for the current shop.
previousarray
Update the previous application access scope.
currentarray
Current application access scope.
updateTimenumber
Access the millisecond timestamp for range updates.
json
{
  "authScope": {
    "current": "[read_order,write_order]",
    "clientId": "58DAED6AEC7AA1C2C8DFD719E8E06E3A",
    "previous": "[read_order]",
    "updateTime": "1732864257361",
    "shopId": "4022054969604"
  }
}

EVENT app uninstalled ​

Occurs whenever a shop has uninstalled the app.

Access scope

Requires ANY of the following access scopes: write_apps read_apps

Topic

EVENT app/uninstalled 

Event Data

uninstalledobject
Uninstall information.
- Hide child properties
clientIdstring
Application's client ID.
shopIdnumber
Unique identifier for the current shop.
json
{
  "uninstalled": {
    "clientId": "58DAED6AEC7AA1C2C8DFD719E8E06E3A",
    "shopId": "4022054969604"
  }
}