List stores

GET /stores

Get a list of stores for the current account

Query parameters

  • per_page integer

    Default value is 15.

  • page integer

    Default value is 1.

  • filter[currency_code] string

    Filter stores by currency code

  • filter[is_live] boolean

    Filter by live/test status

  • filter[payment_gateway] string

    Filter by payment gateway

    Values are Stripe or PayPal.

  • filter[tags][] object

    Filter by custom tags (key-value pairs)

    Hide filter[tags][] attribute Show filter[tags][] attribute object
    • * string Additional properties
  • sort string

    Sort stores by one or more fields. Use '-' prefix for descending order. Available fields: name, subdomain, last_purchase, last_visited, created_at, updated_at Default: -updated_at

Responses

  • 200 application/json

    Successful response

    Hide response attributes Show response attributes object
    • data array[object]

      Store information needed for API operations

      Hide data attributes Show data attributes object
      • id string(uuid)

        Store UUID

      • subdomain string

        Store subdomain used in Store-Subdomain header

      • name string

        Store display name

      • currency object

        Store currency configuration

        Hide currency attribute Show currency attribute object
        • code string

          Currency code (e.g., usd, gbp, eur)

    • meta object
      Hide meta attributes Show meta attributes object
      • current_page integer
      • per_page integer
      • total integer
GET /stores
curl \
 --request GET 'https://api.gb.enjovia.app/stores' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "subdomain": "acme-shop",
      "name": "ACME Store",
      "currency": {
        "code": "usd"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 20,
    "total": 3
  }
}