Get customers
Endpoint: GET /v10/customers
Available nested resources for including: customerGroups
This endpoint will fetch a list of B2B customers
Data of response
| Parameter | Required | Default | Description |
|---|---|---|---|
customers.* | Yes | An array of customers |
Customer
| Parameter | Required | Default | Description |
|---|---|---|---|
customer_number | Yes | The customer number of the customer. This is unique accross your account | |
name | Yes | The name of the customer | |
currency | null | The currency of the customer. NOTE: If this is blank it falls back to country settings | |
country | null | The country of the customer. This is automatically updated whenever the primary address of the customer changes | |
discount_percentage | 0 | The discount percentage of this customer | |
vat_number | null | The VAT Number for this customer | |
ean_number | null | The EAN Number for this customer (used for EAN invoicing) | |
notes | null | Optional fixed notes | |
email | null | Primary contact email (not to be confused with billing_emails) | |
telephone | null | Primary contact telephone number | |
website | null | The website of the customer | |
billing_emails | [] | Billing email(s) of the customer. Orders, invoices, etc. will be sent to these emails | |
meta | {} | An object with {"key": "value"} with custom meta data of the customer. This is used for storing custom fields | |
created_at | Yes | ||
updated_at | Yes |