Create a new customer

post

https://api.ecommerceapi.uk/v1/customers

Creates a new customer.

Body Params

firstName

string

required

The customer's first name.

lastName

string

required

The customer's last name.

string

required

The customer's email address.

password

string

required

Password for the customer's account.

trade

boolean

Indicates whether the customer is a trade customer.

tradeGroupId

integer

The ID of the trade group the customer belongs to, only for trade customers.

active

boolean

Indicates whether the customer account is active, only for trade customers.

credit

boolean

Indicates if the trade customer has a credit account, only for trade customers.

discount

float

Global discount percentage for the trade customer's account, only for trade customers.

costPriceMultiplier

float

Cost price multiplier for the trade customer, only for trade customers.

companyName

string

Company name associated with the customer account.

phone

string

The customer's primary phone number.

mobilePhone

string

The customer's mobile phone number, only for trade customers.

website

string

The customer's website URL, only for trade customers.

vatNumber

string

The customer's VAT registration number, only for trade customers.

acceptsMarketing

boolean

Indicates whether the customer accepts marketing communications.

addressLine1

string

The first line of the customer's address.

addressLine2

string

The second line of the customer's address.

addressLine3

string

The third line of the customer's address.

city

string

The customer's city.

province

string

The customer's county or province (non-US only).

postcode

string

The customer's postcode.

country

integer

The customer's country code.

state

integer

The customer's state code (US only).

notes

string

Internal notes about the customer.

additionalData

object

Additional custom data fields, only for trade customers.

rewardPoints

integer

The customer's reward points balance.

Responses

400

Invalid request data.

401

Unauthorized. Invalid or missing API key.

500

Server error.

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Customer created successfully.