Customers
Search the customers of a store and organize them with tags using the Customers API.
The Customers API lets you look up the people who have bought from a store and group them with tags for campaigns and analysis.
Endpoints are under /stores/{slug}/customers and need an API key with customers:read to read and customers:write to change tags. See Authentication. Handle customer data according to your own privacy policy and applicable law.
List customers
GET /stores/{slug}/customers
| Parameter | Description |
| --- | --- |
| q | Search across email, first name, last name, phone and city. |
| tag | Only customers with this tag. |
| segment | Only customers in this segment, based on purchase behavior. |
| country | Only customers in this country. |
| orders_min | Only customers with at least this many paid orders. |
| page, per_page | Pagination. per_page is 1 to 100. |
curl "https://wafle.click/api/v1/stores/your-store/customers?tag=vip&per_page=25" \
-H "X-Wafle-Store-Key: $WAFLE_KEY"
Customer overview
GET /stores/{slug}/customers/{email}/360 returns a customer's profile, order history and activity in one response.
Tags
Tags are short labels you attach to customers.
| Request | Description |
| --- | --- |
| GET /stores/{slug}/customers/tags | List the tags in use. |
| GET /stores/{slug}/customers/{email}/tags | List a customer's tags. |
| POST /stores/{slug}/customers/{email}/tags | Add a tag to a customer. |
| DELETE /stores/{slug}/customers/{email}/tags/{tag} | Remove a tag from a customer. |
| POST /stores/{slug}/customers/tags/bulk | Add or remove a tag for many customers at once. |
Privacy requests
Customers can ask for their data to be exported or deleted. Use POST /stores/{slug}/customers/{email}/gdpr/export and POST /stores/{slug}/customers/{email}/gdpr/delete to fulfil those requests.
Related
Need help with an integration? Contact support.