Swell

Swell Store API

Public store settings, currencies, payment settings, and menus.

Documentation GitHub OpenAPI

Documentation

https://developers.swell.is/backend-api/introduction

https://developers.swell.is/backend-api/authentication

https://developers.swell.is/backend-api/querying

https://developers.swell.is/backend-api/errors

https://developers.swell.is/frontend-api/introduction

Specifications

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/openapi/swell-io-store-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-schema/swell-product-schema.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-schema/swell-order-schema.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-schema/swell-cart-schema.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-schema/swell-subscription-schema.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-schema/swell-account-schema.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-schema/swell-payment-schema.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-schema/swell-webhook-schema.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-structure/swell-product-structure.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-structure/swell-order-structure.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-structure/swell-subscription-structure.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/json-structure/swell-account-structure.json

Other Resources

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/examples/swell-product-create-example.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/examples/swell-order-create-example.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/examples/swell-subscription-create-example.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/examples/swell-account-create-example.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/examples/swell-webhook-event-example.json

https://raw.githubusercontent.com/api-evangelist/swell-io/refs/heads/main/examples/swell-cart-add-item-example.json

OpenAPI Specification

openapi: 3.0.3
info:
  title: Swell Backend Account Addresses Store API
  version: 2025-01
  description: 'Swell Backend API — the server-side REST surface for managing every resource in a Swell commerce store: products, variants, carts, orders, payments, refunds, shipments, returns, subscriptions, accounts (customers), invoices, coupons, promotions, gift cards, content, files, data models, events, and webhooks. Authenticated with a store ID and secret key. The official Node and PHP libraries connect over a custom wire protocol on port 8443 for improved performance; HTTPS REST is available at https://api.swell.store.'
  contact:
    name: Swell Developer Support
    url: https://developers.swell.is
    email: support@swell.is
  license:
    name: API Profile — API Evangelist
    url: https://apievangelist.com
servers:
- url: https://api.swell.store
  description: Production Backend API
security:
- SwellStoreId: []
  SwellSecretKey: []
tags:
- name: Store
  description: Public store settings, currencies, payment settings, and menus.
paths:
  /api/settings:
    get:
      tags:
      - Store
      summary: Retrieve Store Settings
      operationId: frontendGetSettings
      responses:
        '200':
          description: Public store settings (currency
          locale: null
          store name).: null
  /api/settings/payments:
    get:
      tags:
      - Store
      summary: Retrieve Payment Settings
      operationId: frontendGetPaymentSettings
      responses:
        '200':
          description: Public payment gateway configuration.
  /api/settings/currencies:
    get:
      tags:
      - Store
      summary: List Supported Currencies
      operationId: frontendListCurrencies
      responses:
        '200':
          description: Currencies and exchange rates.
components:
  securitySchemes:
    SwellStoreId:
      type: apiKey
      in: header
      name: X-Store-Id
      description: Your Swell store ID, found in the Developer section of the dashboard.
    SwellSecretKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'Secret API key prefixed with `sk_`. Sent as `Authorization: Basic <base64(store-id:secret-key)>` or equivalent custom header by official libraries.'