Skip to main content
POST
Create a supplier

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"

default_currency_code
string | null

Default ISO 4217 currency code for this supplier (3 letters). Auto-applied to new purchase orders created for the supplier.

Required string length: 3
Example:

"USD"

contact_ids
integer[] | null

IDs of existing contacts to link to this supplier

Example:

Response

Supplier successfully created

data
object