> ## 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. # List seller requirement kinds > The kinds you can add, and the shape of each one's configuration form. `configured` says the store already has this kind — meaningful only where `allow_multiple` is false. `accepts_submissions` says the seller records having done it rather than it being read from their data, and `reviewed_by_operator` says what they send waits for you. A marketplace that registers its own kind server-side sees it here without this endpoint changing. **Required scope:** `read_sellers` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml get /api/v3/admin/seller_requirements/types 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/seller_requirements/types: get: tags: - Seller Requirements summary: List seller requirement kinds description: |- The kinds you can add, and the shape of each one's configuration form. `configured` says the store already has this kind — meaningful only where `allow_multiple` is false. `accepts_submissions` says the seller records having done it rather than it being read from their data, and `reviewed_by_operator` says what they send waits for you. A marketplace that registers its own kind server-side sees it here without this endpoint changing. **Required scope:** `read_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 responses: '200': description: kinds found content: application/json: example: data: - type: accept_terms name: Accept terms description: Read and accept the marketplace terms allow_multiple: false accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: terms_body: type: - string - 'null' x-spree-widget: textarea terms_effective_from: type: - string - 'null' format: date terms_url: type: - string - 'null' additionalProperties: false - type: complete_profile name: Complete profile description: Fill in the public profile shoppers see allow_multiple: false accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: require_about: type: boolean default: true require_logo: type: boolean default: true require_cover_photo: type: boolean default: false require_contact_email: type: boolean default: true additionalProperties: false - type: billing_address name: Billing address description: The address your payouts are billed from allow_multiple: false accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: {} additionalProperties: false - type: returns_address name: Returns address description: The address customer returns are sent to allow_multiple: false accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: {} additionalProperties: false - type: delivery_method name: Delivery method description: Offer at least one way to ship your orders allow_multiple: false accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: {} additionalProperties: false - type: package_type name: Shipping box description: Tell us the size and weight of the box you ship orders in allow_multiple: false accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: {} additionalProperties: false - type: minimum_products name: Minimum products description: List at least this many products allow_multiple: false accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: minimum_count: type: integer default: 1 additionalProperties: false - type: payout_account name: Payout Account description: '' allow_multiple: false accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: {} additionalProperties: false - type: required_custom_fields name: Required custom fields description: Fill in the details the marketplace asks for allow_multiple: false accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: - custom_field_definition_ids schema: type: object properties: {} additionalProperties: false - type: policy name: Seller policy description: Publish a policy with this name allow_multiple: true accepts_submissions: false reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: {} additionalProperties: false - type: attestation name: Seller confirmation description: Confirm this yourself before you are approved allow_multiple: true accepts_submissions: true reviewed_by_operator: false configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: {} additionalProperties: false - type: operator_review name: Manual check description: The marketplace checks this by hand before approving you allow_multiple: true accepts_submissions: true reviewed_by_operator: true configured: false addable: true accepted_content_types: [] association_fields: [] schema: type: object properties: {} additionalProperties: false - type: document name: Document description: Upload this document for the marketplace to review allow_multiple: true accepts_submissions: true reviewed_by_operator: true configured: false addable: true accepted_content_types: - application/pdf - image/jpeg - image/png - image/heic - image/webp - application/msword - >- application/vnd.openxmlformats-officedocument.wordprocessingml.document association_fields: [] schema: type: object properties: {} additionalProperties: false schema: type: object properties: data: type: array items: type: object properties: type: type: string example: document name: type: string example: Document description: type: string example: A file the seller uploads and you review allow_multiple: type: boolean example: true accepts_submissions: type: boolean example: true reviewed_by_operator: type: boolean example: true configured: type: boolean example: false addable: type: boolean example: true description: >- Whether the operator may add one now. The uniqueness rule is the server's, so clients filter on this rather than deriving it. schema: type: object description: JSON Schema of the type's `preferences` 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', }) // What you can ask for, and the configuration each kind takes. A kind your own // code registers server-side shows up here too. const { data: requirementTypes } = await client.sellerRequirements.types() - lang: bash label: Spree CLI source: spree api get /seller_requirements/types components: 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.