| code | Required
Your customers's unique identifier
Example
12345
Syntax
Max 50 characters | - Use a unique value for each customer
- Keep the code the same when updating your data
- Use only valid unicode characters. Avoid invalid characters like control, function, or private area characters
- Use the same code for the same customer - across countries or languages
|
| name | Required
Your customer's name
Example
Acme Company
Syntax
Max 150 characters | - Try to keep the name clean (avoid codes, remarks, unnecessary characters)
|
| addresses | Required
Array with your customer's address(es)
Example
["isPrimary":true, "code":"123456", "type":"Delivery", "name":"Cantona Olsztyn", "addressLine1":"ul. Kanta 230", "zipCode":"10-691", "city":"Olsztyn", "countryCode":"PL", "country":"Polska"]
Syntax
addresses uses 9 sub-attributes:- isPrimary (optional)
The default address - code (optional)
The unique address Id - type (optional)
The address type: shipping or delivery - name (required)
Name of the company - addressLine1 (required)
Street and number - zipCode (required)
Zip code - city (required)
City - countryCode (required)
Two character country code - country (optional)
Country name
| - If your customer has one address, that's fine. Just make sure the required sub-attributes are filled.
|
| phonenumber | Optional
Your customer's phone number
Example
061234567
Syntax
Numeric max 12 characters | |
| currency | Optional
Your customer's currency
Example
EUR
Syntax
3 character currency code (ISO 4217) | |
| language | Optional
Your customer's preferred language
Example
en
Syntax
2 character language code (ISO 639-1) | - Sets the default language in which the apps are initially displayed
- Can be overridden by the customer accounts
|
| blocked | Optional
Indicates the customer is blocked
Example
true
Syntax
true ; false
1 ; 0 | - Blocked customers are not allowed to login or create user accounts
|
| showprices | Optional
Indicates the customer is allowed to see prices
Example
true
Syntax
true ; false
1 ; 0 | - For (potential) customers that are allowed to view the products without prices or the ability place orders
|
| minOrderValue | Optional
Minimum order value
Example
360
Syntax
Numeric | - Orders below this value can not be submitted
|
| customergroups | Optional
The customer group(s) of the customer
Example
["country_10", "customergroup_9999"]
Syntax
Max 50 characters per customergroup | |
| pricegroups | Optional
The price group(s) of the customer
Example
["retail_eu", "export"]
Syntax
Max 50 characters per pricegroup | - Pricegroups can be applied to any number of customers
|
| discounts | Optional
The discount of the customer
Example
["key" : "discount", "value" : 15]
Syntax
Numeric | Comes in three flavors- discount
Converts all prices to net prices beforehand - net prices are shown on all pages - linedisc
Shows original price and discounted price per order line in the cart - gross prices are shown in catalogue pages - enddisc
Shows total discount per order in the cart - gross prices are shown in catalogue pages
|
