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

# Submit against a requirement

> What the seller says about one requirement: an attestation they tick, a
document they upload, a reference they paste.

Create only. A submission records what was said and when, so a seller who
needs to correct something submits again rather than editing, and the
latest one counts.

`file` is **not** a multipart upload — it is the `signed_id` returned by
`POST /api/v3/seller/direct_uploads`, so the bytes are already in storage
by the time this runs.

An attestation is accepted on the spot; a requirement the operator
reviews comes back `pending`.




## OpenAPI

````yaml /api-reference/seller.yaml post /api/v3/seller/requirements/{requirement_id}/submissions
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/requirements/{requirement_id}/submissions:
    parameters:
      - name: requirement_id
        in: path
        description: Requirement ID, as returned by `GET /api/v3/seller/onboarding`
        required: true
        schema:
          type: string
    post:
      tags:
        - Onboarding
      summary: Submit against a requirement
      description: >
        What the seller says about one requirement: an attestation they tick, a

        document they upload, a reference they paste.


        Create only. A submission records what was said and when, so a seller
        who

        needs to correct something submits again rather than editing, and the

        latest one counts.


        `file` is **not** a multipart upload — it is the `signed_id` returned by

        `POST /api/v3/seller/direct_uploads`, so the bytes are already in
        storage

        by the time this runs.


        An attestation is accepted on the spot; a requirement the operator

        reviews comes back `pending`.
      parameters:
        - name: X-Spree-Seller-Id
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                note:
                  type: string
                  description: Anything the seller wants to say alongside the submission
                reference:
                  type: string
                  description: >-
                    A reference number or external identifier, for requirements
                    that ask for one
                file:
                  type: string
                  description: >-
                    A direct-upload `signed_id`, for requirements that ask for a
                    document
      responses:
        '201':
          description: submission recorded
          content:
            application/json:
              example:
                id: selsub_UkLWZg9DAJ
                status: accepted
                note: Confirmed.
                review_note: null
                reference: null
                reviewed_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                file_url: null
                file_name: null
              schema:
                $ref: '#/components/schemas/RequirementSubmission'
        '404':
          description: a requirement belonging to another marketplace
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Seller requirement not found
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearer_auth: []
components:
  schemas:
    RequirementSubmission:
      type: object
      properties:
        id:
          type: string
        status:
          anyOf:
            - type: string
              enum:
                - pending
                - accepted
                - rejected
                - waived
            - type: string
          description: The values listed are the built-in ones; extensions may add more.
        note:
          type: string
          nullable: true
        review_note:
          type: string
          nullable: true
        reference:
          type: string
          nullable: true
        reviewed_at:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        file_url:
          type: string
          nullable: true
        file_name:
          type: string
          nullable: true
      required:
        - id
        - status
        - note
        - review_note
        - reference
        - reviewed_at
        - created_at
        - updated_at
        - file_url
        - file_name
      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
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for an authenticated seller session (`seller_api` audience)

````