> ## 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.

# Look up an invitation

> Reads an invitation from the emailed link, before anyone signs in.

The acceptance page needs the invited address to decide whether it is
asking someone to set a new password or to confirm one they already have.

Unauthenticated — the ID and token in the emailed link are the
credential. A wrong token is indistinguishable from an unknown
invitation: both answer `404`, so the endpoint cannot be used to
enumerate. An invitation onto the store's own staff rather than a seller
answers `404` here too.




## OpenAPI

````yaml /api-reference/seller.yaml get /api/v3/seller/auth/invitations/{id}/lookup
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/invitations/{id}/lookup:
    parameters:
      - name: id
        in: path
        description: Invitation ID from the emailed link
        required: true
        schema:
          type: string
    get:
      tags:
        - Authentication
      summary: Look up an invitation
      description: >
        Reads an invitation from the emailed link, before anyone signs in.


        The acceptance page needs the invited address to decide whether it is

        asking someone to set a new password or to confirm one they already
        have.


        Unauthenticated — the ID and token in the emailed link are the

        credential. A wrong token is indistinguishable from an unknown

        invitation: both answer `404`, so the endpoint cannot be used to

        enumerate. An invitation onto the store's own staff rather than a seller

        answers `404` here too.
      parameters:
        - name: token
          in: query
          required: true
          description: The token from the emailed link
          schema:
            type: string
      responses:
        '200':
          description: invitation found
          content:
            application/json:
              example:
                id: inv_UkLWZg9DAJ
                email: newcomer@acme.test
                created_at: '2026-01-15T12:00:00.000Z'
                expires_at: '2026-01-29T12:00:00.000Z'
                accepted_at: null
                status: pending
                acceptance_url: >-
                  /accept-invitation/inv_UkLWZg9DAJ?token=RgGhNP1euUCS75Nc3V1Y7YQF
              schema:
                $ref: '#/components/schemas/Invitation'
        '404':
          description: wrong token, or an invitation that can no longer be accepted
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Invitation not found, expired, or already accepted.
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Invitation:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
        created_at:
          type: string
        expires_at:
          type: string
          nullable: true
        accepted_at:
          type: string
          nullable: true
        status:
          anyOf:
            - type: string
              enum:
                - pending
                - accepted
            - type: string
          description: The values listed are the built-in ones; extensions may add more.
        acceptance_url:
          type: string
      required:
        - id
        - email
        - created_at
        - expires_at
        - accepted_at
        - status
        - acceptance_url
      x-typelizer: true
    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

````