> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Refresh token

> Exchanges the HttpOnly refresh-token cookie for a new access JWT and a
rotated refresh cookie. No request body or Authorization header is
required — the cookie alone authenticates the call.

The lookup is narrowed by audience, so a refresh token minted for the
storefront or the back office cannot be exchanged for a seller session.
Membership is rechecked here too: a user whose last seller role was
revoked mid-session is refused rather than renewed.




## OpenAPI

````yaml /api-reference/seller.yaml post /api/v3/seller/auth/refresh
openapi: 3.0.3
info:
  title: Seller API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: |
    Spree Seller API v3 - the marketplace seller panel, where a seller runs
    their own shop inside someone else's marketplace.

    This is a branch of its own, not a narrowing of the Admin API. Every
    endpoint is scoped server-side to the seller the request acts as, which
    is what makes cross-seller access impossible by construction rather
    than by rule. Sellers never call the Admin API.

    ## Authentication

    Sign in at `POST /api/v3/seller/auth/login` and send the returned JWT as
    `Authorization: Bearer <token>`. The token carries a `seller_api`
    audience — a token minted for the storefront or the back office is not
    accepted here, and vice versa.

    There is deliberately **no secret API key** for this branch: a
    credential that could act as a seller without a seller signing in is
    exactly what the separate audience exists to prevent.

    ### Choosing a seller

    A user may run more than one seller. Login returns the list; send the
    chosen seller's ID in the `X-Spree-Seller-Id` header on every
    authenticated request. The store is derived from the seller — never
    sent — so no header can widen what a seller reaches. A request that
    names no seller the caller belongs to is rejected with `403`.

    ## Response Format

    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.

    ## Error Handling

    Errors return a consistent format:
    ```json
    {
      "error": {
        "code": "validation_error",
        "message": "Validation failed",
        "details": { "name": ["can't be blank"] }
      }
    }
    ```
  version: v3
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Authentication
    description: Seller sign-in, token refresh, logout, and invitation acceptance
  - name: Account
    description: The signed-in user, the sellers they may act for, and what they may do
  - name: Countries
    description: Country and state reference data for the panel's address forms
  - name: Delivery Methods
    description: >-
      The seller's own ways to ship, and the marketplace methods shared with
      them
  - name: Delivery Profiles
    description: >-
      The marketplace's delivery vocabulary — what kind of goods a product is,
      which decides how it ships
  - name: Delivery Zones
    description: >-
      The marketplace's destinations, for narrowing where a seller's own method
      ships
  - name: Onboarding
    description: >-
      The marketplace checklist a seller completes before admission, and what
      they submit against it
  - name: Policies
    description: The seller's own legal documents, as the marketplace asks them to publish
  - name: Product Types
    description: The types a seller may list a product against, and what each adds
  - name: Products
    description: The seller's own catalog
  - name: Profile
    description: >-
      The seller's own record — presentation, contact details, addresses, and
      tax registration
  - name: Stock Locations
    description: Where the seller keeps stock, and so where their returns are sent
  - name: Team
    description: Who runs this seller, and the invitations nobody has accepted yet
  - name: Uploads
    description: Presigned direct uploads for the documents onboarding asks for
paths:
  /api/v3/seller/auth/refresh:
    post:
      tags:
        - Authentication
      summary: Refresh token
      description: |
        Exchanges the HttpOnly refresh-token cookie for a new access JWT and a
        rotated refresh cookie. No request body or Authorization header is
        required — the cookie alone authenticates the call.

        The lookup is narrowed by audience, so a refresh token minted for the
        storefront or the back office cannot be exchanged for a seller session.
        Membership is rechecked here too: a user whose last seller role was
        revoked mid-session is refused rather than renewed.
      responses:
        '200':
          description: refresh successful
          content:
            application/json:
              example:
                token: >-
                  eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJhZG1pbiIsImp0aSI6IjdjODEzNjdjLTBlYWEtNGUzOC1hNmRjLTJjMTYzOTIxY2Q1MiIsImlzcyI6InNwcmVlIiwiYXVkIjoic2VsbGVyX2FwaSIsImV4cCI6MTc2ODQ3ODcwMH0.N2ttey6pvsPoOdx0F9pdUNbdT1j25ejAzpghXTbB8zo
                user:
                  id: adm_UkLWZg9DAJ
                  email: seller@example.com
                  first_name: Magdalen
                  last_name: Hayes
                  full_name: Magdalen Hayes
                  created_at: '2026-01-15T12:00:00.000Z'
                  avatar_url: null
                sellers:
                  - id: sel_UkLWZg9DAJ
                    name: Seller 3
                    status: approved
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '401':
          description: missing or invalid refresh-token cookie
          content:
            application/json:
              example:
                error:
                  code: invalid_refresh_token
                  message: Refresh token cookie missing
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    AuthResponse:
      type: object
      properties:
        token:
          type: string
          description: JWT access token, `seller_api` audience
        user:
          $ref: '#/components/schemas/TeamMember'
        sellers:
          type: array
          description: >-
            The sellers this user may act for. Pick one and send its `id` as
            `X-Spree-Seller-Id` on every subsequent request.
          items:
            $ref: '#/components/schemas/SellerSummary'
      required:
        - token
        - user
        - sellers
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: record_not_found
            message:
              type: string
              example: Record not found
            details:
              type: object
              description: Field-specific validation errors
              nullable: true
              example:
                name:
                  - is too short
                  - is required
                email:
                  - is invalid
          required:
            - code
            - message
      required:
        - error
      example:
        error:
          code: validation_error
          message: Validation failed
          details:
            name:
              - is too short
            email:
              - is invalid
    TeamMember:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        first_name:
          type: string
          nullable: true
        last_name:
          type: string
          nullable: true
        full_name:
          type: string
          nullable: true
        created_at:
          type: string
        avatar_url:
          type: string
          nullable: true
      required:
        - id
        - email
        - first_name
        - last_name
        - full_name
        - created_at
        - avatar_url
      x-typelizer: true
    SellerSummary:
      type: object
      description: A seller the signed-in user may act for
      properties:
        id:
          type: string
          description: Prefixed seller ID — send as `X-Spree-Seller-Id`
          example: sel_abc123
        name:
          type: string
          example: Acme Supplies
        status:
          type: string
          example: approved
          description: Seller lifecycle status
      required:
        - id
        - name
        - status

````