Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Customers

Create a new customer

Creates a new customer.

🔒 Requires: customers:write scope

post/customers

Request body

company_namestring nullable

Company name.

custom_field_1string nullable

Custom field 1. Can be used to store random data.

custom_field_2string nullable

Custom field 2.

custom_field_3string nullable

Custom field 3.

custom_field_4string nullable

Custom field 4.

customer_codestring

Customer code used for claiming loyalty.

customer_group_idstring

Customer group ID.

date_of_birthstring

Birthday.

do_not_emailboolean

Indicates whether the customer opted out of email communications.

emailstring nullable

Customer's email address.

enable_loyaltyboolean
enable_promotional_smsboolean

Indicates whether the customer opted in to SMS communications.

faxstring nullable

Fax no.

first_namestring nullable required

Customer's first name.

genderstring nullable

Customer's gender. Can be M, F or null.

last_namestring nullable required

Customer 's last name.

mobilestring nullable

Mobile phone no.

notestring nullable

Customer note.

on_account_limitnumber double nullable

Customer's OnAccount Limit.

phonestring nullable

Phone no.

physical_address_1string nullable

Physical address, line 1.

physical_address_2string nullable

Physical address, line 2.

physical_citystring nullable

Physical address, city.

physical_country_idstring nullable

Physical address, country code.

physical_postcodestring nullable

Physical address, post code.

physical_statestring nullable

Physical address, state.

physical_suburbstring nullable

Physical address, suburb.

postal_address_1string nullable

Postal address, line 1.

postal_address_2string nullable

Postal address, line 2.

postal_citystring nullable

Postal address, city.

postal_country_idstring nullable

Postal address, country code.

postal_postcodestring nullable

Postal address, post code.

postal_statestring nullable

Postal address, state.

postal_suburbstring nullable

Postal address, suburb.

tax_idstring nullable

Customer's tax ID.

twitterstring nullable

Twitter handle.

websitestring nullable

Website URL.

Response