> ## Documentation Index
> Fetch the complete documentation index at: https://docs.joinluminous.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a supplier

> Create a new supplier (factory).



## OpenAPI

````yaml /api-reference/build.yaml post /suppliers
openapi: 3.0.0
info:
  title: Luminous API
  version: 1.0.0
  description: API documentation for Luminous
servers:
  - url: https://{companyName}.api.joinluminous.com/external/api/v1
    variables:
      companyName:
        default: companyName
        description: Your company-specific subdomain
security: []
tags:
  - name: Products
    description: Get and manage products
  - name: Pricing
    description: Manage price schedules, levels, and customizations
  - name: BOMs
    description: Manage Bills of Materials (BOMs)
  - name: Labels
    description: Label rendering via Labelary ZPL service
  - name: Companies
    description: Manage business accounts and their associated data
  - name: Contacts
    description: Manage contact information for individuals
  - name: Suppliers
    description: Manage suppliers (factories) — vendors used on purchase orders
  - name: Supplier SKUs
    description: Manage per-supplier SKU and unit-cost overrides for products
  - name: Locations
    description: Manage warehouses and locations
  - name: Inventory
    description: Get and adjust product stock levels
  - name: Lots
    description: Create, update, and delete product lots (batches)
  - name: Transfer Orders
    description: Manage transfer orders
  - name: Fulfillment Orders
    description: Manage fulfillment orders and picklists
  - name: Purchase Orders
    description: Get and modify purchase orders
  - name: Receiving Reports
    description: Manage receiving reports
  - name: Payment Obligations
    description: Manage payment obligations for purchase orders
  - name: Sales Orders
    description: Manage sales orders and sales order shipments
  - name: Purgatory
    description: >-
      Inspect and resolve non-posted sales orders in the purgatory staging
      workflow
  - name: PickFlow Shipping
    description: >-
      Provider-agnostic shipping rates, services, packages, and label purchase
      for PickFlow
  - name: Cycle Counts
    description: >-
      Create, drive, and post PickFlow cycle counts — batches, per-warehouse
      sessions, and CSV import/export
  - name: Print Stations
    description: List paired print stations and enqueue print jobs to them
  - name: Invoices
    description: Get and manage invoices
  - name: Work Orders
    description: >-
      Manage work orders — production lifecycle, steps, materials, links,
      shipments, and comments
  - name: Production Batches
    description: Group and manage work orders as production batches
  - name: Bills
    description: >-
      Accounts payable bill management, payments, attachments, allocations, and
      variance
  - name: Prepayments
    description: Manage vendor prepayments and applications
  - name: Vendor Credits
    description: Manage vendor credits and applications
  - name: Vendor Returns
    description: Manage vendor returns and credit generation
  - name: Customer Returns
    description: Manage customer returns (sales returns), receiving, and restock behavior
  - name: Stock Snapshot
    description: Point-in-time stock snapshots with export support
  - name: Consumption
    description: Consumption reports and exports
  - name: Inventory Aging
    description: Cost-layer-based inventory aging reports
  - name: Bills Reports
    description: Accounts payable bills aging reports
  - name: Forecast
    description: Materialized forecast data
  - name: Reports
    description: Close the books, inventory discrepancy, transaction COGS, and EDI reports
  - name: Tags
    description: Add/remove tags across various resources
  - name: Custom Fields
    description: Get and set custom fields across various resources
  - name: Currency
    description: Currency configuration, exchange rates, and conversion
  - name: Integration Mappings
    description: Manage integration mappings for external systems
  - name: Integration Field Mappings
    description: Manage field-level mappings between Luminous and external systems
paths:
  /suppliers:
    post:
      tags:
        - Suppliers
      summary: Create a supplier
      description: Create a new supplier (factory).
      operationId: createSupplier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 255
                  description: Supplier name
                  example: Acme Manufacturing
                description:
                  type: string
                  nullable: true
                  description: Supplier description
                  example: Primary overseas supplier for apparel
                street_address:
                  type: string
                  maxLength: 255
                  nullable: true
                  example: 123 Industrial Way
                city:
                  type: string
                  maxLength: 255
                  nullable: true
                  example: Shenzhen
                state:
                  type: string
                  maxLength: 255
                  nullable: true
                  example: Guangdong
                zip:
                  type: string
                  maxLength: 255
                  nullable: true
                  example: '518000'
                country:
                  type: string
                  maxLength: 255
                  nullable: true
                  example: China
                factory_admin_id:
                  type: integer
                  nullable: true
                  description: >-
                    ID of the internal user to set as the primary admin for this
                    supplier
                  example: 100
                bank_name:
                  type: string
                  maxLength: 255
                  nullable: true
                  example: Bank of China
                routing_number:
                  type: string
                  maxLength: 255
                  nullable: true
                  example: '021000021'
                account_number:
                  type: string
                  maxLength: 255
                  nullable: true
                  example: '1234567890'
                swift_code:
                  type: string
                  maxLength: 255
                  nullable: true
                  example: BKCHCNBJ
                default_payment_term:
                  type: string
                  nullable: true
                  description: >-
                    Default payment term name. Must match one of the payment
                    term names configured in Luminous.
                  example: Net 30
                default_currency_code:
                  type: string
                  nullable: true
                  minLength: 3
                  maxLength: 3
                  description: >-
                    Default ISO 4217 currency code for this supplier (3
                    letters). Auto-applied to new purchase orders created for
                    the supplier.
                  example: USD
                contact_ids:
                  type: array
                  nullable: true
                  description: IDs of existing contacts to link to this supplier
                  items:
                    type: integer
                  example:
                    - 501
                    - 502
              required:
                - name
      responses:
        '201':
          description: Supplier successfully created
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                        description: Unique identifier for the supplier
                        example: 42
                      status:
                        type: integer
                        description: Numeric status flag (1 = active)
                        example: 1
                      created_at:
                        type: string
                        format: date-time
                        description: When the supplier was created
                        example: '2026-04-20T14:30:00Z'
                      updated_at:
                        type: string
                        format: date-time
                        description: When the supplier was last updated
                        example: '2026-04-20T14:30:00Z'
                      created_by:
                        type: integer
                        nullable: true
                        description: ID of the user that created this supplier
                        example: 100
                      updated_by:
                        type: integer
                        nullable: true
                        description: ID of the user that last updated this supplier
                        example: 100
                      name:
                        type: string
                        description: Supplier name
                        example: Acme Manufacturing
                      description:
                        type: string
                        nullable: true
                        description: Supplier description
                        example: Primary overseas supplier for apparel
                      street_address:
                        type: string
                        nullable: true
                        example: 123 Industrial Way
                      city:
                        type: string
                        nullable: true
                        example: Shenzhen
                      state:
                        type: string
                        nullable: true
                        example: Guangdong
                      zip:
                        type: string
                        nullable: true
                        example: '518000'
                      country:
                        type: string
                        nullable: true
                        example: China
                      factory_admin_id:
                        type: integer
                        nullable: true
                        description: >-
                          ID of the internal user acting as the primary admin
                          for this supplier
                        example: 100
                      supplier_admin_id:
                        type: integer
                        nullable: true
                        description: Alias of `factory_admin_id`
                        example: 100
                      contact_name:
                        type: string
                        nullable: true
                        description: >-
                          Legacy single-contact name (use `contacts` for the
                          full list)
                        example: Jane Doe
                      contact_email:
                        type: string
                        format: email
                        nullable: true
                        description: >-
                          Legacy single-contact email (use `contacts` for the
                          full list)
                        example: jane@acme.example
                      contact_phone:
                        type: string
                        nullable: true
                        description: >-
                          Legacy single-contact phone (use `contacts` for the
                          full list)
                        example: +86 755 1234 5678
                      bank_name:
                        type: string
                        nullable: true
                        example: Bank of China
                      routing_number:
                        type: string
                        nullable: true
                        example: '021000021'
                      account_number:
                        type: string
                        nullable: true
                        example: '1234567890'
                      swift_code:
                        type: string
                        nullable: true
                        example: BKCHCNBJ
                      default_payment_term:
                        type: string
                        nullable: true
                        description: >-
                          Default payment term name, matches the set available
                          to companies
                        example: Net 30
                      default_currency_code:
                        type: string
                        nullable: true
                        description: >-
                          Default ISO 4217 currency code for this supplier.
                          Auto-applied to new purchase orders created for the
                          supplier.
                        example: USD
                      contacts:
                        type: array
                        nullable: true
                        description: >-
                          Linked contacts (only present when the relation is
                          loaded)
                        items:
                          type: object
                          properties:
                            id:
                              type: integer
                              example: 501
                            name:
                              type: string
                              nullable: true
                              example: Jane Doe
                            email:
                              type: string
                              format: email
                              nullable: true
                              example: jane@acme.example
                            phone:
                              type: string
                              nullable: true
                              example: +86 755 1234 5678
                    required:
                      - id
                      - name
                      - status
        '401':
          description: Authentication credentials were missing or invalid
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Unauthorized
                  message:
                    type: string
                    example: Authentication credentials are missing or invalid
                  status_code:
                    type: integer
                    example: 401
        '403':
          description: You do not have permission to perform this action
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Forbidden
                  message:
                    type: string
                    example: You do not have permission to access this resource
                  status_code:
                    type: integer
                    example: 403
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
      security:
        - BearerAuth: []
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        Authenticate using a bearer token. To create a token, navigate to
        /settings/api-tokens and click Create API Token.

````