Swell Account Session API

openapi: 3.2.0
info:
  title: Swell Frontend Account Session API
  version: 2025-01
  description: Swell Frontend API — the client-safe, public-key-authenticated REST surface used from storefronts, single-page apps, and headless commerce experiences. Exposes a curated subset of the Backend API authorized with a public key plus a session token. Powers Swell.js, the React/Vue/Next storefront kits (Origin, Horizon, Verswell), and any custom JAMstack or SSR storefront. Resources include products, categories, carts, accounts, orders, subscriptions, payments, coupons, gift cards, store settings, currencies, localization, menus, and content pages.
  contact:
    name: Swell Developer Support
    url: https://developers.swell.is/frontend-api/introduction
  license:
    name: API Profile — API Evangelist
    url: https://apievangelist.com
servers:
- url: https://{storeId}.swell.store
  description: Per-store Frontend API endpoint
  variables:
    storeId:
      default: my-store
      description: Your Swell store ID (subdomain).
security:
- SwellPublicKey: []
tags:
- name: Account Session
  description: Login, logout, and session recovery.
paths:
  /api/account/login:
    post:
      tags:
      - Account Session
      summary: Log In
      operationId: frontendAccountLogin
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - email
              - password
              properties:
                email:
                  type: string
                  format: email
                password:
                  type: string
      responses:
        '200':
          description: Logged in.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
  /api/account/logout:
    post:
      tags:
      - Account Session
      summary: Log Out
      operationId: frontendAccountLogout
      responses:
        '200':
          description: Logged out.
  /api/account/recover:
    post:
      tags:
      - Account Session
      summary: Send Account Recovery Email
      operationId: frontendAccountRecover
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                email:
                  type: string
                  format: email
      responses:
        '200':
          description: Recovery email sent.
  /api/account/recover/{key}:
    parameters:
    - name: key
      in: path
      required: true
      schema:
        type: string
    put:
      tags:
      - Account Session
      summary: Reset Account Password
      operationId: frontendAccountResetPassword
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                password:
                  type: string
      responses:
        '200':
          description: Password reset.
components:
  schemas:
    Account:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
          format: email
        first_name:
          type: string
        last_name:
          type: string
        phone:
          type: string
        currency:
          type: string
        balance:
          $ref: '#/components/schemas/Money'
    Money:
      type: number
      format: float
  securitySchemes:
    SwellPublicKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'Public storefront key, prefixed with `pk_`. Pass as `Authorization: pk_...`.'