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

> Creates a customer. No welcome email is sent automatically.

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



## OpenAPI

````yaml /api-reference/admin.yaml post /api/v3/admin/customers
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 authentication
  - name: Product Catalog
    description: Products, variants, and option types
  - name: Orders
    description: >-
      Order management — orders, items, payments, fulfillments, refunds, gift
      cards, store credits
  - name: Customers
    description: Customer management — profiles, addresses, store credits, credit cards
  - name: Configuration
    description: Store configuration — payment methods, tag autocomplete
paths:
  /api/v3/admin/customers:
    post:
      tags:
        - Customers
      summary: Create a customer
      description: |-
        Creates a customer. No welcome email is sent automatically.

        **Required scope:** `write_customers` (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:
              type: object
              required:
                - email
              properties:
                email:
                  type: string
                  example: new@example.com
                first_name:
                  type: string
                last_name:
                  type: string
                phone:
                  type: string
                accepts_email_marketing:
                  type: boolean
                internal_note:
                  type: string
                tags:
                  type: array
                  items:
                    type: string
                metadata:
                  type: object
      responses:
        '201':
          description: customer created
          content:
            application/json:
              example:
                id: cus_gbHJdmfrXB
                email: newcustomer@example.com
                first_name: New
                last_name: Customer
                phone: null
                accepts_email_marketing: false
                full_name: New Customer
                available_store_credit_total: '0'
                display_available_store_credit_total: $0.00
                login: null
                metadata: {}
                last_sign_in_at: null
                current_sign_in_at: null
                created_at: '2026-05-09T10:04:28.839Z'
                updated_at: '2026-05-09T10:04:28.839Z'
                sign_in_count: 0
                failed_attempts: 0
                last_sign_in_ip: null
                current_sign_in_ip: null
                tags: []
                internal_note_html: null
                default_billing_address_id: null
                default_shipping_address_id: null
                orders_count: 0
                total_spent: '0.0'
                display_total_spent: $0.00
                last_order_completed_at: null
      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',
            })

            const customer = await client.customers.create({
              email: 'jane@example.com',
              first_name: 'Jane',
              last_name: 'Doe',
              phone: '+1 212 555 1234',
              tags: ['wholesale'],
              accepts_email_marketing: true,
            })
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

````