Create a new customer

post

https://{domain_prefix}.retail.lightspeed.app/api/2.0/customers

Creates a new customer.

🔒 Requires: customers:write scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

first_name

string | null

required

Customer's first name.

last_name

string | null

required

Customer 's last name.

customer_code

string

Customer code used for claiming loyalty.

customer_group_id

string

Customer group ID.

enable_loyalty

boolean

string | null

Customer's email address.

note

string | null

Customer note.

gender

string | null

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

date_of_birth

string

Birthday.

company_name

string | null

Company name.

do_not_email

boolean

Defaults to false

Indicates whether the customer opted out of email communications.

enable_promotional_sms

boolean

Defaults to false

Indicates whether the customer opted in to SMS communications.

phone

string | null

Phone no.

mobile

string | null

Mobile phone no.

fax

string | null

Fax no.

twitter

string | null

Twitter handle.

website

string | null

Website URL.

physical_address_1

string | null

Physical address, line 1.

physical_address_2

string | null

Physical address, line 2.

physical_suburb

string | null

Physical address, suburb.

physical_city

string | null

Physical address, city.

physical_postcode

string | null

Physical address, post code.

physical_state

string | null

Physical address, state.

physical_country_id

string | null

Physical address, country code.

postal_address_1

string | null

Postal address, line 1.

postal_address_2

string | null

Postal address, line 2.

postal_suburb

string | null

Postal address, suburb.

postal_city

string | null

Postal address, city.

postal_postcode

string | null

Postal address, post code.

postal_state

string | null

Postal address, state.

postal_country_id

string | null

Postal address, country code.

custom_field_1

string | null

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

custom_field_2

string | null

Custom field 2.

custom_field_3

string | null

Custom field 3.

custom_field_4

string | null

Custom field 4.

on_account_limit

double | null

Customer's OnAccount Limit.

tax_id

string | null

Customer's tax ID.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

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

application/json

new

201