Get a customer

Internal numeric ID. Set by the server. Customers are addressed by customerNumber in URLs, not by this ID.

Unique customer number, e.g. CUS-000-2026-00042. Set by the server on create; used in the URL of every single-customer call.

Customer's email address. Required, must be a valid email and unique across customers.

Mobile number, up to 20 characters. Must be unique across customers when set.

Dialling or country code that goes with the phone numbers, up to 10 characters, e.g. +971.

Landline number, up to 20 characters.

First name. Required, up to 255 characters.

Last name, up to 255 characters.

City of the customer's address.

State, province or emirate of the customer's address, as free text.

Country of the customer's address, as free text.

Postal or ZIP code, up to 20 characters.

URL of the customer's photo or avatar, up to 1024 characters.

ACTIVE, INACTIVE, ARCHIVED or DELETED. Defaults to ACTIVE. List customers returns only ACTIVE by default when any filter is used.

Date of birth, YYYY-MM-DD.

Merchant-defined customer group, e.g. "Wholesale", up to 64 characters. Filterable by exact match.

When the profile was last changed, ISO 8601 date-time. Defaults to the current time if not sent.

When the profile was created, ISO 8601 date-time. Defaults to the current time if not sent.

India: the customer's 15-character GST identification number. Set via Partially update a customer.

India: the customer's 10-character PAN (tax ID).

India: GST status - REGULAR, COMPOSITION, UNREGISTERED, CONSUMER (B2C), SEZ or OVERSEAS. Null means not stated. Set via Partially update a customer.

India: two-character GST state code of the buyer, used to work out the place of supply.

The customer's VAT registration number, up to 20 characters; shown on VAT reports and the EC Sales List.

Two-letter country code of the customer's VAT registration, e.g. DE.

true when the customer's EU VAT number has been validated. Only validated customers appear on the EC Sales List.

Marks the customer as exempt from EU VAT. Stored for reference only; it does not currently change how VAT is charged or reported.

US: sales-tax exemption certificate number, shown on Americas tax reports.

US: state that issued the tax exemption certificate.

Mexico: the customer's RFC tax ID, up to 13 characters.

true when the customer was created through the AI assistant or an AI data import. Set by the server.

ID of the AI assistant or AI import session that created or last changed the customer, if any. Set by the server.