The Create Customer API allows a new customer to be created and their information saved when they place an order. Their basic account and contact information is assigned on this initial creation, and custom data can be added when applicable.
The .json address above can be used to access the schema within Postman. An example use of the Customer API follows below, or view the schema or the sample Postman collection.
In this example, the customer details includes these particular properties:
- Customer named TEST CUSTOMER
- Being set up with the email “email@example.com” and the password “password”
These parameters are necessary for the Create Customer API to return a successful response:
|firstName||string||The first name of the customer. The minimum length is 1 and the maximum length is 300.|
|lastName||string||The last name of the customer. The minimum length is 1 and the maximum length is 300.|
|email||string||The email address of the customer. The minimum length is 1 and the maximum length is 250.|
|phone1||string||The phone number of the customer. The minimum length is 1 and the maximum length is 20.|
|password||string||A unique password for the customer. The minimum length is 5 and the maximum length is 48.|
This additional information can also be provided during customer creation:
|phone2||string||A secondary phone number for the customer. The maximum length is 20.|
|customData||array||A set of custom data for the customer. See the schema for more details.|
The Full Request
This is the complete request that will create a new customer.
The Full Response
This is the full response returned by the API, detailing the information about the newly created customer.