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

# Waive a requirement for a seller

> Excuses this one seller from a requirement the marketplace asks of
everyone, recorded as a `waived` submission. The operator never
submits on the seller's behalf: this endpoint only waives.


**Required scope:** `write_sellers` (for API-key authentication).



## OpenAPI

````yaml /api-reference/admin.yaml post /api/v3/admin/sellers/{seller_id}/requirement_submissions
openapi: 3.0.3
info:
  title: Admin API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: >
    Spree Admin API v3 - Administrative API for managing products, orders, and
    store settings.


    ## Authentication


    The Admin API requires a secret API key passed in the `x-spree-api-key`
    header.

    Secret API keys can be generated in the Spree admin dashboard.


    ## Response Format


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

    Single resource endpoints return a flat JSON object.


    ## Resource IDs


    Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,

    `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,

    request bodies, and Ransack filters all accept them directly.


    ## 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: Admin user login, logout, token refresh, and current user profile
  - name: Allowed Origins
    description: CORS allowlist for storefront and admin client origins
  - name: API Keys
    description: Secret and publishable API keys
  - name: Categories
    description: >-
      Hierarchical product categories — tree management, repositioning, and
      product assignments
  - name: Channels
    description: >-
      Sales channels, product publication across channels, and per-channel order
      routing rules
  - name: Custom Fields
    description: >-
      Custom field definitions for products, variants, customers, and other
      resources
  - name: Customer Groups
    description: >-
      Customer groups for segmenting customers (e.g. wholesale, VIP) used by
      pricing and promotions
  - name: Customers
    description: Customer profiles, addresses, credit cards, and store credits
  - name: Email Templates
    description: >-
      Customer email templates, the email layout and shared partials: drafts,
      previews, publishing and history
  - name: Exports
    description: Async CSV exports of admin resources
  - name: Files
    description: Uploading the files that product media, imports, logos and documents use
  - name: Fulfillments
    description: Order fulfillments — shipments, fulfill, cancel, resume, split
  - name: Gift Cards
    description: Gift cards and gift card batches
  - name: Imports
    description: >-
      Async CSV imports of admin resources, with per-row status and failed-row
      retry
  - name: Markets
    description: >-
      Markets — geographic groupings of countries used for pricing, tax, and
      fulfillment rules
  - name: Option Types
    description: >-
      Option types and option values used to build product variants (e.g. Size,
      Color)
  - name: Orders
    description: Orders, order items, applied gift cards, and applied store credits
  - name: Payment Methods
    description: Configured payment providers and their available types
  - name: Payments
    description: Order payments — list, capture, void
  - name: Pricing
    description: >-
      Prices and price lists for currency-, market-, and customer-group-specific
      pricing
  - name: Products
    description: >-
      Products, taxons/categories, product custom field values, and bulk product
      operations
  - name: Policies
    description: The store's legal documents — terms of service, privacy, returns, shipping
  - name: Reasons
    description: >-
      Merchant-owned vocabularies for why a return, claim, refund, cancellation
      or tax exemption happened
  - name: Promotions
    description: Promotions, promotion rules, promotion actions, and coupon codes
  - name: Refunds
    description: Order refunds
  - name: Settings
    description: Store-level settings — store profile, tags, and configuration
  - name: Staff
    description: Admin users, roles, and invitations to the store
  - name: Stock Locations
    description: Warehouses and physical fulfillment locations
  - name: Store Credits
    description: Prepaid customer balances across all customers, and each balance's ledger
  - name: Variants
    description: >-
      Product variants — the individual SKUs (size/color combinations) sold
      under a product
  - name: Webhooks
    description: Webhook endpoints and webhook delivery history
paths:
  /api/v3/admin/sellers/{seller_id}/requirement_submissions:
    parameters:
      - name: seller_id
        in: path
        required: true
        description: Seller prefixed ID
        schema:
          type: string
    post:
      tags:
        - Sellers
      summary: Waive a requirement for a seller
      description: |-
        Excuses this one seller from a requirement the marketplace asks of
        everyone, recorded as a `waived` submission. The operator never
        submits on the seller's behalf: this endpoint only waives.


        **Required scope:** `write_sellers` (for API-key authentication).
      parameters:
        - name: x-spree-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SellerRequirementWaiveParams'
        required: true
      responses:
        '201':
          description: requirement waived
          content:
            application/json:
              example:
                id: selsub_UkLWZg9DAJ
                status: waived
                note: null
                review_note: Verified offline
                reference: null
                metadata: {}
                reviewed_at: '2026-01-15T12:00:00.000Z'
                created_at: '2026-01-15T12:00:00.000Z'
                updated_at: '2026-01-15T12:00:00.000Z'
                seller_id: sel_UkLWZg9DAJ
                requirement_id: selreq_UkLWZg9DAJ
                requirement_name: VAT number check
                file_url: null
                file_name: null
              schema:
                $ref: '#/components/schemas/SellerRequirementSubmission'
        '404':
          description: the requirement belongs to another store
          content:
            application/json:
              example:
                error:
                  code: record_not_found
                  message: Seller requirement not found
      security:
        - api_key: []
          bearer_auth: []
      x-codeSamples:
        - lang: javascript
          label: Spree Admin SDK
          source: >-
            import { createAdminClient } from '@spree/admin-sdk'


            const client = createAdminClient({
              baseUrl: 'https://your-store.com',
              secretKey: 'sk_xxx',
            })


            // Excuses this seller from a requirement every other seller still
            has to meet.

            const submission = await
            client.sellers.requirementSubmissions.waive('sel_UkLWZg9DAJ', {
              requirement_id: 'selreq_UkLWZg9DAJ',
              review_note: 'Registered charity, exempt from the business licence check.',
            })
        - lang: bash
          label: Spree CLI
          source: >-
            spree api post /sellers/{seller_id}/requirement_submissions -d
            '{"requirement_id":"selreq_UkLWZg9DAJ","review_note":"Registered
            charity, exempt from the business licence check."}'
components:
  schemas:
    SellerRequirementWaiveParams:
      type: object
      properties:
        requirement_id:
          type: string
          description: The requirement the seller is excused from.
          example: selreq_UkLWZg9DAJ
        review_note:
          type: string
          description: Why the seller is excused. Kept with the decision.
      required:
        - requirement_id
    SellerRequirementSubmission:
      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
        metadata:
          type: object
          nullable: true
        reviewed_at:
          type: string
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        seller_id:
          type: string
        requirement_id:
          type: string
        requirement_name:
          type: string
        file_url:
          type: string
          nullable: true
        file_name:
          type: string
          nullable: true
      required:
        - id
        - status
        - note
        - review_note
        - reference
        - metadata
        - reviewed_at
        - created_at
        - updated_at
        - seller_id
        - requirement_id
        - requirement_name
        - file_url
        - file_name
      x-typelizer: true
  securitySchemes:
    api_key:
      type: apiKey
      name: x-spree-api-key
      in: header
      description: Secret API key for admin access
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for admin user authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.