> ## 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. # Create a seller > Opens a seller record. The seller starts as `pending` and has no team yet — invite someone to run it with the `invite` action below. `status` is deliberately not writable here or on update: every move through the lifecycle is its own action, because each one does more than set a column. **Required scope:** `write_sellers` (for API-key authentication). ## OpenAPI ````yaml /api-reference/admin.yaml post /api/v3/admin/sellers 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: post: tags: - Sellers summary: Create a seller description: |- Opens a seller record. The seller starts as `pending` and has no team yet — invite someone to run it with the `invite` action below. `status` is deliberately not writable here or on update: every move through the lifecycle is its own action, because each one does more than set a column. **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/SellerCreateParams' required: true responses: '201': description: seller created content: application/json: example: id: sel_gbHJdmfrXB name: Northwind Books slug: northwind-books about: '' about_html: '' logo_url: null square_logo_url: null cover_photo_url: null status: pending contact_email: hi@northwind.example billing_email: null tax_remittance: seller payouts_schedule_interval: null metadata: {} holiday_mode_until: null terms_accepted_at: null created_at: '2026-01-15T12:00:00.000Z' updated_at: '2026-01-15T12:00:00.000Z' deleted_at: null minimum_payout_amount: null on_holiday: false sellable: false products_count: 0 users_count: 0 onboarding_progress: done: 0 total: 0 onboarding_complete: true legal_name: null registration_number: null schema: $ref: '#/components/schemas/Seller' '422': description: validation error content: application/json: example: error: code: validation_error message: Name can't be blank and Slug can't be blank details: name: - code: blank message: can't be blank specific: false slug: - code: blank message: can't be blank specific: false schema: $ref: '#/components/schemas/ErrorResponse' 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', }) // The seller starts as `pending` and has no team yet — invite someone to run // it next. const seller = await client.sellers.create({ name: 'Northwind Books', contact_email: 'hi@northwind.example', }) - lang: bash label: Spree CLI source: >- spree api post /sellers -d '{"name":"Northwind Books","contact_email":"hi@northwind.example"}' components: schemas: SellerCreateParams: type: object properties: external_references: type: object additionalProperties: true description: >- Identities the record has in external systems, keyed by system: the same `{ system: external_id }` map the Admin API renders, so what you read can be sent straight back. Systems you do not name keep the reference they have. A list of `{ system, external_id }` entries is accepted too. name: type: string example: Northwind Books slug: type: string description: URL-safe slug, derived from the name when omitted. example: northwind-books contact_email: type: string example: hi@northwind.example nullable: true billing_email: type: string example: billing@northwind.example nullable: true about: type: string description: 'Sanitized HTML: the seller''s public description.' example:

Independent bookshop.

nullable: true logo_signed_id: type: string description: >- A `signed_id` from the files upload endpoint to set the image, `null` to remove it, or omit the key to leave it untouched. The same applies to `square_logo_signed_id` and `cover_photo_signed_id`. nullable: true square_logo_signed_id: type: string nullable: true cover_photo_signed_id: type: string nullable: true tax_remittance: type: string enum: - seller - platform example: seller payouts_schedule_interval: type: string nullable: true enum: - daily - weekly - biweekly - monthly - manual minimum_payout_amount: type: string format: decimal pattern: ^-?\d+(\.\d+)?$ example: '25.0' nullable: true holiday_mode_until: type: string format: date-time description: 'Set while the seller is away: the catalog stays but stops selling.' nullable: true legal_name: type: string nullable: true registration_number: type: string nullable: true metadata: type: object additionalProperties: true billing_address: allOf: - $ref: '#/components/schemas/SellerAddressParams' description: >- The seller's own billing address, written inline. There is no `billing_address_id`: an address belongs to whoever it was created for, so it is never referenced by id. custom_fields: type: array items: $ref: '#/components/schemas/CustomFieldValueParams' description: Custom field values, each validated against its definition. required: - name Seller: type: object properties: id: type: string name: type: string slug: type: string about: type: string about_html: type: string logo_url: type: string nullable: true square_logo_url: type: string nullable: true cover_photo_url: type: string nullable: true status: anyOf: - type: string enum: - pending - invited - canceled - onboarding - ready_for_review - approved - rejected - suspended - type: string description: The values listed are the built-in ones; extensions may add more. contact_email: type: string nullable: true billing_email: type: string nullable: true tax_remittance: type: string enum: - seller - platform payouts_schedule_interval: type: string nullable: true enum: - daily - weekly - biweekly - monthly - manual metadata: type: object nullable: true holiday_mode_until: type: string nullable: true terms_accepted_at: type: string nullable: true created_at: type: string updated_at: type: string deleted_at: type: string nullable: true minimum_payout_amount: type: string nullable: true on_holiday: type: boolean sellable: type: boolean products_count: type: number users_count: type: number onboarding_progress: type: object onboarding_complete: type: boolean legal_name: type: string nullable: true registration_number: type: string nullable: true billing_address: $ref: '#/components/schemas/Address' returns_address: $ref: '#/components/schemas/Address' required: - id - name - slug - about - about_html - logo_url - square_logo_url - cover_photo_url - status - contact_email - billing_email - tax_remittance - payouts_schedule_interval - metadata - holiday_mode_until - terms_accepted_at - created_at - updated_at - deleted_at - minimum_payout_amount - on_holiday - sellable - products_count - users_count - onboarding_progress - onboarding_complete - legal_name - registration_number 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 SellerAddressParams: type: object properties: first_name: type: string last_name: type: string company: type: string address1: type: string address2: type: string city: type: string postal_code: type: string phone: type: string label: type: string country_code: allOf: - $ref: '#/components/schemas/CountryCode' description: ISO 3166-1 alpha-2 code, such as `US`. example: US state_code: type: string description: The state or province abbreviation, such as `NY`. example: NY state_name: type: string description: For countries without states in the database. CustomFieldValueParams: type: object properties: id: type: string custom_field_definition_id: type: string value: description: >- A scalar for text, number and boolean fields; a list or a hash for JSON fields. Address: type: object properties: id: type: string label: type: string nullable: true first_name: type: string nullable: true last_name: type: string nullable: true full_name: type: string address1: type: string nullable: true address2: type: string nullable: true postal_code: type: string nullable: true city: type: string nullable: true phone: type: string nullable: true company: type: string nullable: true country_name: type: string country_code: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW state_text: type: string nullable: true state_code: type: string nullable: true quick_checkout: type: boolean is_default_billing: type: boolean is_default_shipping: type: boolean state_name: type: string nullable: true owner: allOf: - $ref: '#/components/schemas/AddressOwner' nullable: true metadata: type: object created_at: type: string updated_at: type: string latitude: type: number nullable: true longitude: type: number nullable: true customer_id: type: string nullable: true required: - id - label - first_name - last_name - full_name - address1 - address2 - postal_code - city - phone - company - country_name - country_code - state_text - state_code - quick_checkout - is_default_billing - is_default_shipping - state_name - owner - metadata - created_at - updated_at - latitude - longitude - customer_id x-typelizer: true CountryCode: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW AddressOwner: type: object properties: id: type: string type: anyOf: - type: string enum: - customer - company - seller - type: string description: The values listed are the built-in ones; extensions may add more. name: type: string nullable: true required: - id - type - 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.