It's not only for new shops, but it's also possible to process a one-time import of customer registrations. It is usually a list of customers from a previous online shop solution. The input should be a CSV file.
- CSV delimiter has to be semicolon
;. - Values can be enclosed in the double quotation mark
"xx", which allows the item's value to contain a semicolon. - If item's value contains double quotation mark, it must be doubled
"". - Character encoding must be UTF-8.
- Special UTF-8 characters are not allowed.
- The first row must contain a header with exact column names.
- Order of columns is not mandatory.
Supported columns
emailAddress
- Login e-mail address.
- Unique for each customer.
- Mandatory.
uuid
- UUID identifier of the user in UUID hexadecimal format.
- Example:
123e4567-e89b-12d3-a456-426655440000. - Optional.
- If not provided, the shop will generate a one.
codename
- A unique alphanumeric identifier of the customer from your system.
- Max length is 20 characters.
- It will be converted to lower case.
- If you send a same codename for multiple customers, it will be imported only for the first one.
- Example:
123e4567e89b. - Optional.
- If not provided, the shop will generate a one.
password.plain
- Passwords for imported customers can be imported from a plain form (not yet hashed).
- However, we highly recommend to not import plain passwords due to security reason.
- All paswords in the shop are hashed with a secure hashing algorithm and once hashed, they cannot be read.
- Imported customers will be able to generate a new password via the "Forrgotten password" feature in the shop.
- Optional.
registrationTime
- User registration date and time.
- The supported format is
YYYY-MM-DD HH:MM:SS. - Example:
2022-07-11 17:46:21. - Optional
- If not provided, the registration time will be the time of the import execution.
internalNote
- Internal note related to the customer. This note is visible only in the shop administration. Customer will not see it.
- Optional.
contactAddress.emailAddress
- Contact e-mail address of the customer.
- It is used as a default value for the customer's new orders.
- It can be a different e-mail address than the one for logging-in.
- Optional.
contactAddress.phoneNumber.countryPrefix
- Country prefix of the contact phone number.
- Examples:
420,+420,00420. - It is used as a default value for the customer's new orders.
- Optional.
contactAddress.phoneNumber.nationalNumber
- National number part of the contact phone number.
- It has to be number without the country prefix.
- Example:
277277972. - It is used as a default value for the customer's new orders.
- Optional.
contactAddress.personName.givenName
- Given name of the customer.
- Examples:
Bruce,George. - Optional.
contactAddress.personName.familyName
- Family name of the customer.
- Examples:
Wayne,Orwell. - Optional.
contactAddress.personName.honorificPrefix
- Honorific or an academic title used in front of the name.
- Examples:
Dr,Prof.,Mr,Ing.,Sir. - Optional.
contactAddress.personName.honorificSuffix
- Honorific or an academic title used after the name.
- Examples:
Ph.D.,M.B.A.. - Optional.
billingAddress.companyIdentification.companyName
- Company name for a billing purpose (invoice).
- It should be provided if the customer is a B2B customer.
- Optional.
billingAddress.companyIdentification.companyRegNumber
- Company or a business registration number for a billing purpose (invoice).
- It should be provided if the customer is a B2B customer.
- Optional.
billingAddress.companyIdentification.taxIdNumber
- TAX ID number of the company or business customer for a billing purpose (invoice).
- In many countries TAX ID is same as VAT ID.
- It should be provided if the customer is a B2B customer.
- Optional.
billingAddress.companyIdentification.vatIdNumber
- VAT (Value Added Tax) ID number of the company or business customer for a billing purpose (invoice).
- In many countries TAX ID is same as VAT ID.
- It should be provided if the customer is a B2B customer.
- Optional.
billingAddress.postalAddress.streetAndHouseNumber
- Street name and house number for a billing purpose (invoice).
- Optional.
billingAddress.postalAddress.city
- City for a billing purpose (invoice).
- Optional.
billingAddress.postalAddress.postalCode
- Postal code for a billing purpose (invoice).
- Optional.
billingAddress.postalAddress.countryCode
- Country code for a billing purpose (invoice).
- Examples:
CZ,GB,US,PL,DE,LV. - Accepted values are 2-character long ISO 3166-1 Alpha-2 codes
- Optional.
deliveryAddress.personName.givenName
- Given name of the customer.
- Examples:
Bruce,George. - Optional.
deliveryAddress.personName.familyName
- Family name of the customer.
- Examples:
Wayne,Orwell. - Optional.
deliveryAddress.personName.honorificPrefix
- Honorific or an academic title used in front of the name.
- Examples:
Dr,Prof.,Mr,Ing.,Sir. - Optional.
deliveryAddress.personName.honorificSuffix
- Honorific or an academic title used after the name.
- Examples:
Ph.D.,M.B.A.. - Optional.
deliveryAddress.companyName
- Company name for a delivery purpose (shipping).
- It is useful if the customer wants shipping to a company building.
- Optional.
deliveryAddress.postalAddress.streetAndHouseNumber
- Street name and house number for a delivery purpose (shipping).
- Optional.
deliveryAddress.postalAddress.city
- Street name and house number for a delivery purpose (shipping).
- Optional.
deliveryAddress.postalAddress.postalCode
- Postal code for a delivery purpose (shipping).
- Optional.
deliveryAddress.postalAddress.countryCode
- Country code for a delivery purpose (shipping).
- Examples:
CZ,GB,US,PL,DE,LV. - Accepted values are 2-character long ISO 3166-1 Alpha-2 codes
- Optional.
agreement.newsletter
- Boolean value (true/false) that tells if the customer agreed with receiving newsletters (subscribed to newlsetters).
- Accepted values:
0,1,true,false,yes,noor empty value. - Optional.
- By default, clients will be imported without the agreement to receive newlsetters.
userGroups
- A list of user group names to which will be a customer assigned.
- User groups should be in one column separated by a comma.
- Example:
B2B, VIP customers, Garage. By this example, the customer will be assigned to 3 user groups. - Optional.