Create or update a customer

post deprecated

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

DEPRECATED This endpoint has a 2.0 equivalent. We recommend using that instead.

Returns a single new or updated customer object.

🔒 Requires: customers:write scope

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

New or updated customer attributes

uuid

Existing customer ID. If included in the POST request it will cause an update instead of a creating a new customer.

customer_code

string

Short, unique customer code.

customer_group_id

uuid

The ID of the customer group this customer is associated with.

first_name

string

Customer's first name.

last_name

string

Customer's last name.

company_name

string

Customer's company name.

phone

string

Customer's phone number.

mobile

string

Customer's mobile phone number.

fax

string

Customer's fax number.

string

Customer's email address.

twitter

string

Twitter handle.

website

string

Website URL.

physical_address1

string

Address, line 1 - physical.

physical_address2

string

Address, line 2 - physical.

physical_suburb

string

Suburb - physical.

physical_city

string

City - physical.

physical_postcode

string

Post code - physical.

physical_state

string

State - physical.

physical_country_id

string

Country code - physical.

postal_address1

string

Address, line 1 - postal.

postal_address2

string

Address, line 2 - postal.

postal_suburb

string

Suburb - postal.

postal_city

string

City - postal.

postal_postcode

string

Post code - postal.

postal_state

string

State - postal.

postal_country_id

string

Country code - postal.

enable_loyalty

int32

Indicates whether customer's purchases should incur loyalty. 0 or 1.

date_of_birth

string

Customer's date of birth.

sex

string

Customer's gender.

custom_field_1

string

Custom field 1, able to store any data as a string.

custom_field_2

string

Custom field 2, able to store any data as a string.

custom_field_3

string

Custom field 3, able to store any data as a string.

custom_field_4

string

Custom field 4, able to store any data as a string.

note

string

Customer related notes.

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

200