Skip to content

Installation

Identity of the token's install and store

GET/installation#

Identify the install and store behind this token

Scope not declared in the specification

Needs no scope. Returns the platform-issued ids an app must key its storage on (install.id, store.id), the effective scope set every request is checked against, the store's currency exponent, locale and timezone, and the current webhook subscription without its secret. store.slug is display-only and can change.

Parameters

No parameters.

Responses

200

The install and its store

NameTypeDescription
dataRequiredInstallation

The install and the store it is bound to, as the platform sees them.

  • 401

    Missing, invalid, expired, or revoked token

  • 429

    Token budget exhausted (180 requests/minute, 60 writes/minute per install)

Request
curl -X GET "https://dukkan.one/platform-api/v1/installation" \
  -H "Authorization: Bearer $DUKKAN_ACCESS_TOKEN"
Response
{
  "data": {
    "install": {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "app_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "status": "active",
      "granted_scopes": [
        "string"
      ],
      "effective_scopes": [
        "string"
      ],
      "distribution_channel": "development",
      "installed_at": "2026-08-18T16:00:00Z",
      "api_version": "string",
      "webhook": {
        "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
        "endpoint_url": "string",
        "topics": [
          "order.created"
        ],
        "status": "active",
        "consecutive_failures": 1,
        "activated_at": "2026-08-18T16:00:00Z",
        "disabled_at": "2026-08-18T16:00:00Z"
      }
    },
    "store": {
      "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
      "slug": "string",
      "name": "Olive oil 1 L",
      "currency": "SYP",
      "decimals": 0,
      "locale": "string",
      "timezone": "string",
      "country": "string",
      "is_development": true
    }
  }
}