Skip to content

Store

Public identity and checkout facts of the token's store

GET/store#

Public identity and checkout facts of the store

Scope not declared in the specification

Needs no scope; everything here is already public on the storefront. Carries the pricing currency, the currencies a customer may pay in, the store-adjusted FX table checkout applies (integer scaled / 10^scale, base at identity), the enabled manual payment methods with the ShamCash id shown at checkout, the province vocabulary for shipping_address.province, and the public https origin (a connected custom domain wins).

Parameters

No parameters.

Responses

200

The store profile

NameTypeDescription
dataRequiredStore

Public identity and checkout facts of the token's store.

  • 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/store" \
  -H "Authorization: Bearer $DUKKAN_ACCESS_TOKEN"
Response
{
  "data": {
    "id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b",
    "slug": "string",
    "name": "Olive oil 1 L",
    "description": "string",
    "logo_url": "string",
    "banner_urls": [
      "string"
    ],
    "storefront_url": "string",
    "whatsapp_number": "string",
    "phone": "string",
    "address": "string",
    "accent_color": "string",
    "locale": "string",
    "timezone": "string",
    "country": "string",
    "pricing_currency": {
      "code": "invalid_request",
      "decimals": 0
    },
    "storefront_currencies": {
      "allowed": [
        "string"
      ],
      "default": "string"
    },
    "fx": {
      "base": "string",
      "as_of": "2026-08-18T16:00:00Z",
      "rates": {}
    },
    "payment_methods": [
      {
        "id": "cod",
        "shamcash_id": "6f1d2c3b-4a59-4e8f-9b70-2d1c3e4f5a6b"
      }
    ],
    "provinces": [
      {
        "value": "string",
        "ar": "string",
        "en": "string"
      }
    ]
  }
}