openapi: 3.0.3
info:
  title: Admin Account / Address Users 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.\n\n## Authentication\n\nThe Admin API requires a secret API key passed in the `x-spree-api-key` header.\nSecret API keys can be generated in the Spree admin dashboard.\n\n## Response Format\n\nAll responses are JSON. List endpoints return paginated responses with `data` and `meta` keys.\nSingle resource endpoints return a flat JSON object.\n\n## Resource IDs\n\nEvery resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,\n`variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,\nrequest bodies, and Ransack filters all accept them directly.\n\n## Error Handling\n\nErrors return a consistent format:\n```json\n{\n  \"error\": {\n    \"code\": \"validation_error\",\n    \"message\": \"Validation failed\",\n    \"details\": { \"name\": [\"can't be blank\"] }\n  }\n}\n```\n"
  version: v3
servers:
- url: http://{defaultHost}
  variables:
    defaultHost:
      default: localhost:3000
tags:
- name: Users
paths:
  /api/v2/platform/users:
    get:
      summary: Return a list of Users
      tags:
      - Users
      security:
      - bearer_auth: []
      description: Returns a list of Users
      operationId: users-list
      parameters:
      - name: page
        in: query
        example: 1
        schema:
          type: integer
      - name: per_page
        in: query
        example: 50
        schema:
          type: integer
      - name: include
        in: query
        description: 'Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
        example: ship_address,bill_address
        schema:
          type: string
      - name: filter[user_id_eq]
        in: query
        description: ''
        example: '1'
        schema:
          type: string
      - name: filter[email_cont]
        in: query
        description: ''
        example: spree@example.com
        schema:
          type: string
      responses:
        '200':
          description: Records returned
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                    - id: '129'
                      type: user
                      attributes:
                        email: ivonne.braun@smith.biz
                        first_name: Liberty
                        last_name: Becker
                        selected_locale: nil
                        created_at: '2022-11-08T19:35:53.726Z'
                        updated_at: '2022-11-08T19:35:53.726Z'
                        public_metadata: {}
                        private_metadata: {}
                        average_order_value: []
                        lifetime_value: []
                        store_credits: []
                      relationships:
                        bill_address:
                          data: null
                        ship_address:
                          data: null
                    - id: '130'
                      type: user
                      attributes:
                        email: lenita.mayer@kulas.us
                        first_name: Chasidy
                        last_name: Strosin
                        selected_locale: fr
                        created_at: '2022-11-08T19:35:53.730Z'
                        updated_at: '2022-11-08T19:35:53.730Z'
                        public_metadata: {}
                        private_metadata: {}
                        average_order_value: []
                        lifetime_value: []
                        store_credits: []
                      relationships:
                        bill_address:
                          data: null
                        ship_address:
                          data: null
                    - id: '131'
                      type: user
                      attributes:
                        email: dewayne@terrybarton.info
                        first_name: Ruben
                        last_name: Schmidt
                        selected_locale: de
                        created_at: '2022-11-08T19:35:53.732Z'
                        updated_at: '2022-11-08T19:35:53.732Z'
                        public_metadata: {}
                        private_metadata: {}
                        average_order_value: []
                        lifetime_value: []
                        store_credits: []
                      relationships:
                        bill_address:
                          data: null
                        ship_address:
                          data: null
                    meta:
                      count: 3
                      total_count: 3
                      total_pages: 1
                    links:
                      self: http://www.example.com/api/v2/platform/users?page=1&per_page=&include=&filter[user_id_eq]=&filter[email_cont]=
                      next: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
                      prev: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
                      last: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
                      first: http://www.example.com/api/v2/platform/users?filter%5Bemail_cont%5D=&filter%5Buser_id_eq%5D=&include=&page=1&per_page=
              schema:
                $ref: '#/components/schemas/resources_list'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
    post:
      summary: Create a User
      tags:
      - Users
      security:
      - bearer_auth: []
      description: Creates a User
      operationId: create-user
      parameters:
      - name: include
        in: query
        description: 'Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
        example: ship_address,bill_address
        schema:
          type: string
      responses:
        '201':
          description: Record created
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                      id: '136'
                      type: user
                      attributes:
                        email: rex_champlin@breitenberg.com
                        first_name: Zenia
                        last_name: King
                        selected_locale: pl
                        created_at: '2022-11-08T19:35:54.351Z'
                        updated_at: '2022-11-08T19:35:54.351Z'
                        public_metadata: {}
                        private_metadata: {}
                        average_order_value: []
                        lifetime_value: []
                        store_credits: []
                      relationships:
                        bill_address:
                          data: null
                        ship_address:
                          data: null
              schema:
                $ref: '#/components/schemas/resource'
        '422':
          description: Invalid request
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: Bill address belongs to other user
                    errors:
                      bill_address_id:
                      - belongs to other user
              schema:
                $ref: '#/components/schemas/validation_errors'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_user_params'
  /api/v2/platform/users/{id}:
    get:
      summary: Return a User
      tags:
      - Users
      security:
      - bearer_auth: []
      description: Returns a User
      operationId: show-user
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: include
        in: query
        description: 'Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
        example: ship_address,bill_address
        schema:
          type: string
      responses:
        '200':
          description: Record found
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                      id: '139'
                      type: user
                      attributes:
                        email: gaynell@parisian.biz
                        first_name: Irwin
                        last_name: DuBuque
                        selected_locale: en
                        created_at: '2022-11-08T19:35:54.635Z'
                        updated_at: '2022-11-08T19:35:54.635Z'
                        public_metadata: {}
                        private_metadata: {}
                        average_order_value: []
                        lifetime_value: []
                        store_credits: []
                      relationships:
                        bill_address:
                          data: null
                        ship_address:
                          data: null
              schema:
                $ref: '#/components/schemas/resource'
        '404':
          description: Record not found
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The resource you were looking for could not be found.
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
    patch:
      summary: Update a User
      tags:
      - Users
      security:
      - bearer_auth: []
      description: Updates a User
      operationId: update-user
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: include
        in: query
        description: 'Select which associated resources you would like to fetch, see: <a href="https://jsonapi.org/format/#fetching-includes">https://jsonapi.org/format/#fetching-includes</a>'
        example: ship_address,bill_address
        schema:
          type: string
      responses:
        '200':
          description: Record updated
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    data:
                      id: '144'
                      type: user
                      attributes:
                        email: john@example.com
                        first_name: Astrid
                        last_name: Kohler
                        selected_locale: fr
                        created_at: '2022-11-08T19:35:55.180Z'
                        updated_at: '2022-11-08T19:35:55.414Z'
                        public_metadata: {}
                        private_metadata: {}
                        average_order_value: []
                        lifetime_value: []
                        store_credits: []
                      relationships:
                        bill_address:
                          data: null
                        ship_address:
                          data: null
              schema:
                $ref: '#/components/schemas/resource'
        '422':
          description: Invalid request
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: Bill address belongs to other user
                    errors:
                      bill_address_id:
                      - belongs to other user
              schema:
                $ref: '#/components/schemas/validation_errors'
        '404':
          description: Record not found
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The resource you were looking for could not be found.
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_user_params'
    delete:
      summary: Delete a User
      tags:
      - Users
      security:
      - bearer_auth: []
      description: Deletes a User
      operationId: delete-user
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Record deleted
        '404':
          description: Record not found
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The resource you were looking for could not be found.
              schema:
                $ref: '#/components/schemas/error'
        '401':
          description: Authentication Failed
          content:
            application/vnd.api+json:
              examples:
                Example:
                  value:
                    error: The access token is invalid
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    update_user_params:
      type: object
      properties:
        user:
          type: object
          properties:
            email:
              type: string
            first_name:
              type: string
            last_name:
              type: string
            password:
              type: string
            password_confirmation:
              type: string
            selected_locale:
              type: string
            ship_address_id:
              type: string
            bill_address_id:
              type: string
            public_metadata:
              type: object
            private_metadata:
              type: object
      required:
      - user
      x-internal: false
    resource_properties:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
        attributes:
          type: object
        relationships:
          type: object
      required:
      - id
      - type
      - attributes
      x-internal: false
    error:
      type: object
      properties:
        error:
          type: string
      required:
      - error
      x-internal: false
    resources_list:
      type: object
      properties:
        data:
          type: array
          items:
            allOf:
            - $ref: '#/components/schemas/resource_properties'
        meta:
          type: object
          properties:
            count:
              type: integer
            total_count:
              type: integer
            total_pages:
              type: integer
          required:
          - count
          - total_count
          - total_pages
        links:
          type: object
          properties:
            self:
              type: string
            next:
              type: string
            prev:
              type: string
            last:
              type: string
            first:
              type: string
          required:
          - self
          - next
          - prev
          - last
          - first
      required:
      - data
      - meta
      - links
      x-internal: false
    create_user_params:
      type: object
      properties:
        user:
          type: object
          required:
          - email
          - password
          - password_confirmation
          properties:
            email:
              type: string
            first_name:
              type: string
            last_name:
              type: string
            password:
              type: string
            password_confirmation:
              type: string
            selected_locale:
              type: string
            ship_address_id:
              type: string
            bill_address_id:
              type: string
            public_metadata:
              type: object
            private_metadata:
              type: object
      required:
      - user
      x-internal: false
    resource:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/resource_properties'
      required:
      - data
      x-internal: false
    validation_errors:
      type: object
      properties:
        error:
          type: string
        errors:
          type: object
      required:
      - error
      - errors
      x-internal: false
  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
x-tagGroups:
- name: Authentication
  tags:
  - Authentication
- name: Products & Catalog
  tags:
  - Products
  - Variants
  - Option Types
  - Custom Fields
  - Channels
- name: Pricing
  tags:
  - Pricing
  - Markets
- name: Orders & Fulfillment
  tags:
  - Orders
  - Payments
  - Fulfillments
  - Refunds
- name: Customers
  tags:
  - Customers
  - Customer Groups
- name: Promotions & Gift Cards
  tags:
  - Promotions
  - Gift Cards
- name: Data
  tags:
  - Exports
- name: Configuration
  tags:
  - Settings
  - Stock Locations
  - Payment Methods
  - Staff
  - API Keys
  - Allowed Origins
  - Webhooks