Create customer

POST https://app.ecwid.com/api/v3/{storeId}/customers/{customerId}

Required access scopes

Your app must have the following access scopes to make this request: create_customers

Path params

All path params are required.

Param	Type	Description
storeId	number	Ecwid store ID.

Headers

The Authorization header is required.

Header	Format	Description
Authorization	Bearer secret_ab***cd	Access token of the application.

Request JSON

A JSON object with the following fields:

Field	Type	Description
email	string	Customer's email.
password	string	Customer's password. Only available for stores with the legacy customer sign-in.
billingPerson	object billingPerson	Customer's billing name/address.
shippingAddresses	array of objects shippingAddresses	List of saved shipping addresses for the customer.
contacts	array of objects contacts	Customer's contact information: email, phone, social media links.
customerGroupId	number	ID of the customer group the customer is assigned to.
taxId	string	Customer's tax ID.
taxIdValid	boolean	Defines if customer's tax ID is valid.
taxExempt	boolean	Defines if customer is tax exempt. Requires a valid tax ID. Read more about handling tax exempt customers in Help Center.
acceptMarketing	boolean	Defines if the customer has accepted email marketing. If true, you can use customer's email for promotions.
lang	string	Customer's language code. Customers see storefront and emails in this language. This language must be one of the translations enabled in the store.
privateAdminNotes	string	Personal notes about the customer. Visible only to the store owner.

billingPerson

Field	Type	Description
name	string	Full name of the customer.
companyName	string	Customer's company name.
street	string	Address line 1 and address line 2, separated by \n.
city	string	City.
countryCode	string	Two-letter country code.
countryName	string	Country name.
postalCode	string	Postal/ZIP code.
stateOrProvinceCode	string	State/province code, for example, NY.
stateOrProvinceName	string	State/province name.
phone	string	Customer's phone number.

shippingAddresses

Field	Type	Description
id	number	Internal ID of the saved address.
name	string	Full name of the customer.
companyName	string	Customer's company name.
street	string	Address line 1 and address line 2, separated by \n.
city	string	City.
countryCode	string	Two-letter country code.
countryName	string	Country name.
postalCode	string	Postal/ZIP code.
stateOrProvinceCode	string	State/province code, for example, NY.
stateOrProvinceName	string	State/province name.
phone	string	Customer's phone number.
addressFormatted	string	Formatted full address. Includes street, city, state, and country names.

contacts

Field	Type	Description
id	number	Internal ID of the customer contact, for example, 113861381.
contact	string	Email or link to reach the contact. Examples: [e-mail] contact for EMAIL type. https://www.facebook.com/myshop_page contact for FACEBOOK type.
handle	string	Contact identifier on social media. For example, for FACEBOOK type of contact, it's a page slug: contact field: https://www.facebook.com/myshop_page handle field: myshop_page
note	string	Store owner's notes on the contact.
type	string	Contact type. Customer can have several contacts of the same type. One of: EMAIL, PHONE, FACEBOOK, INSTAGRAM, TWITTER, YOUTUBE, TIKTOK, PINTEREST, VK, FB_MESSENGER, WHATSAPP, TELEGRAM, VIBER, URL, OTHER.
default	boolean	Defines if it's a default customer contact. Only one contact of the same type can be default.
orderBy	boolean	Sorting order for contacts on the customer details page. Starts with 0 and increments by 1.
timestamp	string	Datetime when the customer contact was created.

Response JSON

A JSON object with the following fields:

Field	Type	Description
createCount	number	The number of created items that defines if the request was successful. One of: 1 if the item was created, 0 if the item was not created.