Create New Customer
POST/customers
(🚧 in development) This endpoint creates a new customer in the system.
The system will ensure the uniqueness of the customer either within the entire company or a shop. This depends on whether you include shopId in the request or not. If the customer already exists for the company or the shop, the system returns an error.
Request​
- application/json
Body
required
Customer creation request data.
The unique identifier of the shop within the merchant company. If not provided, the customer will be unique across the entire company. If provided, the customer will be unique within this shop.
customer objectrequired
The identifier of the customer within the merchant's system. Must be unique within the company or shop. If not provided, the system will generate one.
The customer's first name.
The customer's last name.
The customer's middle name, if applicable.
The customer's phone number.
The customer's email address.
Responses​
- 200
Customer successfully created.
- application/json
- Schema
- Example (from schema)
Schema
data objectrequired
The unique identifier of the customer.
The first name of the customer.
The last name of the customer.
The middle name of the customer, if provided.
The customer's phone number, if provided.
The customer's email address.
{
"data": {
"customerId": "cust789",
"firstName": "John",
"lastName": "Doe",
"middleName": "A",
"phone": "+1234567890",
"email": "john.doe@example.com"
}
}