Add a new customer
Using this endpoint, you can add a new customer to the system. The response includes an id
which is required in subsequent calls, such as GET /customers/{customerId}
, PUT /customers/{customerId}
, PATCH /customers/{customerId}
, and more.
When externalId
is specified, the customers have the ability to manage their own details through the storefront UI.
Authorizations
The access token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
A UUID of the request.
Body
The full name of the customer.
The customer's email.
A UUID of the customer.
A placeholder for additional info, in key-value pairs.
Response
A 24-character system-generated customer ID.
The full name of the customer.
The customer's email.
A flag indicating whether the customer data is deleted. true
indicates the customer data is deleted and false
indicates otherwise.
The time when the customer was added, in UTC format.
The time when the customer details were last updated, in UTC format.
The status of the customer.
ACTIVE
, INACTIVE
, BLOCKED
A UUID of the customer.
A placeholder for additional info, in key-value pairs.
The time when the customer data was deleted, in UTC format.
Was this page helpful?