Skip to main content
POST
Create Customer

Authorizations

X-API-Key
string
header
required

API Key for authentication

Body

application/json

request

reference_id
string
required
Maximum string length: 255
Example:

"CUS123"

assigned_sales_rep_ids
string[]
required
Minimum array length: 1
assigned_price_list_id
string
required
company_name
string
Maximum string length: 255
Example:

"Company Name"

display_name
string
Maximum string length: 255
Example:

"Customer Display Name"

display_id
string

Display ID; generated by system if not provided

Maximum string length: 255
Example:

"1234567890"

freight_term
string
Maximum string length: 255
shipping_method
string
Maximum string length: 255
payment_mode
string
Maximum string length: 255
payment_term
string
Maximum string length: 255
first_name
string
Maximum string length: 255
Example:

"John"

last_name
string
Maximum string length: 255
Example:

"Doe"

phone
string

E.164 format

Example:

"+14155552671"

email
string
Example:

"john.doe@example.com"

addresses
object[]
contacts
object[]
attributes
object[]
tax_rate
number
Example:

0

customer_type
string
Example:

"retail"

Response

Created

data
object