Skip to main content
POST
/
suppliers
Create a supplier
curl --request POST \
  --url https://{companyName}.api.joinluminous.com/external/api/v1/suppliers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Manufacturing",
  "description": "Primary overseas supplier for apparel",
  "street_address": "123 Industrial Way",
  "city": "Shenzhen",
  "state": "Guangdong",
  "zip": "518000",
  "country": "China",
  "factory_admin_id": 100,
  "bank_name": "Bank of China",
  "routing_number": "021000021",
  "account_number": "1234567890",
  "swift_code": "BKCHCNBJ",
  "default_payment_term": "Net 30",
  "contact_ids": [
    501,
    502
  ]
}
'
{
  "data": {
    "id": 42,
    "status": 1,
    "name": "Acme Manufacturing",
    "created_at": "2026-04-20T14:30:00Z",
    "updated_at": "2026-04-20T14:30:00Z",
    "created_by": 100,
    "updated_by": 100,
    "description": "Primary overseas supplier for apparel",
    "street_address": "123 Industrial Way",
    "city": "Shenzhen",
    "state": "Guangdong",
    "zip": "518000",
    "country": "China",
    "factory_admin_id": 100,
    "supplier_admin_id": 100,
    "contact_name": "Jane Doe",
    "contact_email": "jane@acme.example",
    "contact_phone": "+86 755 1234 5678",
    "bank_name": "Bank of China",
    "routing_number": "021000021",
    "account_number": "1234567890",
    "swift_code": "BKCHCNBJ",
    "default_payment_term": "Net 30",
    "contacts": [
      {
        "id": 501,
        "name": "Jane Doe",
        "email": "jane@acme.example",
        "phone": "+86 755 1234 5678"
      }
    ]
  }
}

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.

Authorizations

​
Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Body

application/json
​
name
string
required

Supplier name

Maximum string length: 255
Example:

"Acme Manufacturing"

​
description
string | null

Supplier description

Example:

"Primary overseas supplier for apparel"

​
street_address
string | null
Maximum string length: 255
Example:

"123 Industrial Way"

​
city
string | null
Maximum string length: 255
Example:

"Shenzhen"

​
state
string | null
Maximum string length: 255
Example:

"Guangdong"

​
zip
string | null
Maximum string length: 255
Example:

"518000"

​
country
string | null
Maximum string length: 255
Example:

"China"

​
factory_admin_id
integer | null

ID of the internal user to set as the primary admin for this supplier

Example:

100

​
bank_name
string | null
Maximum string length: 255
Example:

"Bank of China"

​
routing_number
string | null
Maximum string length: 255
Example:

"021000021"

​
account_number
string | null
Maximum string length: 255
Example:

"1234567890"

​
swift_code
string | null
Maximum string length: 255
Example:

"BKCHCNBJ"

​
default_payment_term
string | null

Default payment term name. Must match one of the payment term names configured in Luminous.

Example:

"Net 30"

​
contact_ids
integer[] | null

IDs of existing contacts to link to this supplier

Example:
[501, 502]

Response

Supplier successfully created

​
data
object