Skip to main content
POST
Creates a new customer for a corporation.

Request body

string
required
The unique identifier for the corporation
string
required
Customer name (minimum 3 characters)
string
Customer email address (must be valid email format)
string
External identifier for the customer from your system
string
A tax or business registration number for the customer (e.g., VAT ID, EIN, GST number). Used to identify the customer’s tax status in applicable jurisdictions.
object
Customer’s shipping address

Response

string
Unique identifier for the customer
string
Customer name
string
Customer email address
string
The corporation ID this customer belongs to
int64
Unix timestamp of when the customer was created
string
Source platform identifier (if applicable)
string
Source platform name (if applicable)
string
The customer’s tax or business registration number, if provided

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

A display name for this customer.

Minimum string length: 3
Example:

"John Doe"

corporation_id
string
required

The unique identifier for a corporation this customer belongs to.

Example:

"b6d009b0-d174-463f-b030-94643c28e209"

email
string<email>

Email address of the customer.

shipping_address
object

Address object. Only country is required at the schema level. All other field requirements (including postal_code and state) vary by country — use the /address-requirements endpoint to check which fields are REQUIRED, OPTIONAL, or IGNORED for a given country. When provided, postal codes and state codes are validated against country-specific formats and allowed values.

external_id
string

External identifier for the customer.

business_identification_number
string

Business identification number for the customer (e.g., tax ID, VAT number, or EIN).

Response

Information about the created customer

data
object
message
string
Example:

"Successfully created customer."