Skip to main content

Other Endpoints

Gift Cards​

Required scope: gift_cards:read

Get Gift Card Balance​

GET /api/v1/gift_cards/:id

Returns the gift card's current balance and transaction history.

Store Credits​

Required scope: store_credits:read

Store credit balances are included in the Customers API response as store_credit_balance.

Store Settings​

Required scope: products:read

Get Store Settings​

GET /api/v1/settings

Returns store configuration including tax rates, timezone, currency, and enabled features.

Response (excerpt)​

{
  "data": {
    "locale": "en",
    "store": {
      "name": "Green Leaf Dispensary",
      "address": "123 Main St",
      "phone": "555-123-4567"
    },
    "tax": {
      "mode": "single",
      "rate": 13.0,
      "name": "HST"
    },
    "timezone": "America/Toronto",
    "currency": {
      "symbol": "$"
    }
  }
}
Limited settings

The settings endpoint returns non-sensitive store configuration only. Internal settings like printer IPs, payment gateway credentials, and feature flags are not exposed.