Customers are people who buy from the authenticated company.
GET /v1/companies/5678/customers |
|
GET /v1/companies/5678/customers ?reference_id=ABC123 |
reference_id
then multiple customers for the same client may share the same
reference_id
, so you will receive an array of
customers for zero (representing no customers found) or more
customers. However, the response will always be a
200
success.GET /v1/companies/5678/customers/389427 |
|
GET /v1/companies/5678/customers ?email=jmcdonald@kounta.kom |
|
GET /v1/companies/5678/customers ?first_name=Jamie&last_name=McDonald&phone=02+8765+4321 |
reference_id
for the customer then an empty string is returned.first_name
, last_name
, and phone
must be provided.302
redirect to the matching customer record, or 404
if not found.Creation of new customers is currently limited to the fields below.
POST /v1/companies/5678/customers |
first_name
and either email
or phone
are
required.reference_id
is an identifier you can set that is applicable only to your application. You could use this to store a mapping to that same customer in your system.
You can not see reference_id values assigned by other applications.country
should be specified as a two-character ISO 3166-1 country code.Modification of customers is currently limited to the first_name
, last_name
, phone
, email
, tags
, image
,
primary_address
, shipping_address
, reference_id
and accepts_marketing
.
PUT /v1/companies/5678/customers/389427 |
PUT /v1/companies/5678/customers/389427 |
Here is a list of the supported webhook topics.
When a customer is created. You will receive the complete customer.
When a customer is updated. You will receive the complete customer after the modifications have been applied.
You also may provide the following attribute filters:
name
- if either
first_name
or
last_name
are updated.
phone
email
address
- if either
primary_address
or
shipping_address
are updated.
tags
image
accepts_marketing
When a customer is deleted. You will receive the complete customer.