Skip to main content
POST
Create a customer
Creates a new customer in the store. The email must be unique within the store. The store is bound to your app token server-side — never send a shop id.

Authorizations

Authorization
string
header
required

Installed-app access token (prefix app_), issued by the OAuth install flow. The store is bound to the token server-side — never send a shop id.

Body

application/json

Fields accepted when creating a customer.

name
string
required

Customer's display name.

email
string<email>
required

Customer email address. Required by the data model and must be unique within the store; must be a valid email.

phone
string | null

Customer phone number. May be null.

user
string | null

ObjectId of an existing platform user to link this customer to. May be null.

active
boolean
default:true

Whether the customer is active. Defaults to true.

Response

The created customer.

Standard Salesive response envelope. The operation-specific payload is carried in data.

status
integer
required

HTTP status code, echoed in the body.

success
boolean
required

Whether the request succeeded.

message
string
required

Human-readable result message.

data
object

A store-scoped customer record.