Create a customer

post

https://api.smoothpos.net/customer.json

Creates a new customer. Send the customer's details in the body; you get the saved customer back, including its new id.

Required permission:

Group	Permission
Customers	Create, edit and delete customers (includes view)

Body Params

address

object

required

birthdate

object

credit_balance

number

required

Store credit the customer has available.

string

email_subscriber

boolean

required

Whether the customer subscribes to email marketing.

first_name

string

integer

Unique ID. Set by Smooth POS.

last_name

string

loyalty_optin

boolean

required

Whether the customer has opted in to your loyalty program.

loyalty_optin_date

date-time

When the customer opted in to loyalty.

loyalty_points

integer

required

The customer's current loyalty points balance.

loyalty_points_value

number

required

What the customer's points are worth in your currency.

loyalty_tier

integer

required

Index of the customer's loyalty tier.

loyalty_tier_expiration

date-time

When the customer's current loyalty tier expires.

metadata

object

middle_name

string

sales

array of objects | null

The customer's sales, when included. null in list responses.

sales

sex

string

sms_subscriber

boolean

required

Whether the customer subscribes to SMS marketing.

200Success.

400The request couldn't be processed. Possible error messages: email address is required email already exists on another customer phone number already exists on another customer failed to create customer invalid market_id failed to assign customer market incorrect data format

404Not found. Smooth POS also answers with a 404 when your token is missing or invalid, so check the error message. Possible error messages: not authorised