Requires the following access scope: read_customers
Add responseFields
query param, specifying field names you want to receive.
Example: ?responseFields=id,email,taxId
A JSON object with the following fields:
Field | Type | Description |
---|
id | number | Unique internal customer ID |
email | string | Customer email |
registered | string | Registration date, e.g 2014-06-06 18:57:19 +0400 |
updated | string | Last updated date, e.g 2014-06-06 18:57:19 +0400 |
customerGroupId | number | Customer group ID |
billingPerson | Person | Customer's billing name/address |
shippingAddresses | Array<ShippingAddress> | Customer address book items (deprecated for new instant site customer accounts) |
contacts | Array<Contacts> | Customer's contact information |
customerGroupName | string | Customer group name |
taxId | string | Customer tax ID |
taxIdValid | boolean | true if customer tax ID is valid, false otherwise |
b2b_b2c | string | Order type: business-to-business (b2b ) or business-to-consumer (b2c ) |
fiscalCode | string | Fiscal code of a customer |
electronicInvoicePecEmail | string | PEC email for invoices |
electronicInvoiceSdiCode | string | SDI code for invoices |
taxExempt | boolean | true if customer is tax exempt, false otherwise. Learn more |
acceptMarketing | boolean | true if customer has accepted email marketing and you can use their email for promotions. If value is false , you can't use this email for promotions |
lang | string | Customer's language code (based on the language of the storefront). |
stats | <Stats> | Customer's statistical information |
Field | Type | Description |
---|
name | string | Customer full name |
companyName | string | Customer company name |
street | string | Street |
city | string | City |
countryCode | string | Country code (2-letter code) |
countryName | string | Country name |
postalCode | string | Postal code (zip code) |
stateOrProvinceCode | string | State/province code |
stateOrProvinceName | string | State/province name |
phone | string | Phone number |
Field | Type | Description |
---|
id | number | Internal address ID |
name | string | Customer full name |
companyName | string | Customer company name |
street | string | Street |
city | string | City |
countryCode | string | Country (2-digits code) |
countryName | string | Country name |
postalCode | string | Postal code (zip code) |
stateOrProvinceCode | string | State/province code |
stateOrProvinceName | string | State/province name |
phone | string | Phone number |
Field | Type | Description |
---|
id | number | Unique contact Id |
contact | string | Customer's contact data (email, phone, etc) |
type | string | Type of contact data. Values: EMAIL , PHONE , WHATSAPP , TELEGRAM , VIBER , FACEBOOK , INSTAGRAM , TWITTER , TIKTOK , URL , OTHER |
handle | string | Short customer's id for social contacts |
default | boolean | true if the contact is primary (default). Only one contact of each type (EMAIL , PHONE ) can be default. |
note | string | Merchant's comments about a contact |
orderBy | number | Sort position |
timestamp | string | Date of creating/updating the contact |
Field | Type | Description |
---|
numberOfOrders | number | Number of customer orders in the store |
salesValue | number | Total revenue received from the customer |
averageOrderValue | number | Average revenue received from the customer |
firstOrderDate | string | Date the customer placed the first order in the store |
lastOrderDate | string | Date the customer placed the latest order in the store |
In case of error, Ecwid responds with an error HTTP status code and, optionally, JSON-formatted body containing error description
HTTP Status | Meaning |
---|
404 | Customer is not found |
500 | Cannot retrieve the customer info because of an error on the server |
Field | Type | Description |
---|
errorMessage | string | Error message |