Create Customer

post

https://api.ewitypos.com/apps-v1/customers

Creates a customer in the store. Requires the p/c-customer permission. When the company's "unique customer mobile" setting is enabled, creating a second customer with an existing mobile number fails with 400 BAD_REQUEST. If address is given it is also stored as the customer's default address record. passport is only persisted when the company's passport-scanning setting is enabled. credit_limit defaults to the company's default credit limit when omitted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 190

Customer name.

mobile

string

required

Mobile number (numeric).

string | null

address

string | null

Main address text. Also creates a default address record.

birthday

date | null

Must be a date before today.

passport

string | null

Stored only when the passport-scanning company setting is enabled.

tax_number

string | null

bill_note

string | null

Note printed on the customer's bills.

note

string | null

Internal note about the customer.

credit_limit

number | null

credit

number | null

Accepted by validation but currently ignored — the customer's credit balance is derived from the credit ledger. Use the credit-adjustment endpoint to set an opening balance.

price_level

string

Price level identifier applied to this customer's sales.

Headers

X-Ewity-Store

string

required

The merchant install this request acts on (install.store_id from the app.installed webhook).

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/json

200The created customer.

400Duplicate mobile number (when the unique-mobile company setting is enabled).

422Validation error.