Create customer

POST

customers

object

emailAddress

string

firstName

string

lastName

string

phoneNumber

string

address

object

addressLine1

string

addressLine2

string

city

string

postalCode

string

country

string

state

string

companyName

string

vatNumber

string

registrationNumber

string

shippingAddress

object

addressLine1

string

addressLine2

string

city

string

postalCode

string

country

string

state

string

companyName

string

vatNumber

string

registrationNumber

string

metadata

object

locale

enum<string>

clientReferenceId

string

Authorizations

Authorization

string

headerrequired

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

Body

application/json

emailAddress

string

required

The primary email address of the customer.

firstName

string | null

The first name of the customer.

lastName

string | null

The last name of the customer.

phoneNumber

string | null

The phone number of the customer. Must include the country code.

address

object

The address of the customer.

shippingAddress

object

The shipping address of the customer.

metadata

object

Additional metadata for the customer.

locale

enum<string>

The locale preference of the customer.

Available options:

en_US,

fr_FR

clientReferenceId

string

Unique string of your choice to reconcile with your internal system.

Response

201 - application/json

string

required

The id of the customer.

emailAddress

string

required

The primary email address of the customer.

firstName

string | null

required

The first name of the customer.

lastName

string | null

required

The last name of the customer.

phoneNumber

string | null

required

The phone number of the customer.

livemode

boolean

required

Wether the customer is in live mode or test mode.

isBlocked

boolean

required

Wether the customer is blocked or not.

organizationId

string

required

The id of the organization.

addressId

string | null

required

The id of the shippingAddress.

shippingAddressId

string | null

required

The id of the shippingAddress.

metadata

object | null

required

Additional metadata for the customer.

createdAt

string

required

createdBy

string | null

required

The id of the user who created the customer.

updatedAt

string

required

blockedAt

string | null

required

blockedBy

string | null

required

The id of the user who blocked the customer.

updatedBy

string | null

required

The id of the user who last updated the customer.

deletedAt

string | null

required

List customers Get customer

API Reference

Customers

Orders

Referral Groups

Authorizations

Body

Response