Retrieving customer data

Keep your CRM up to date

Configuration values

You'll need an API key to include with all requests. Depending on how your business and CRM are structured you may want to filter your data by domainID which represents the property the order was placed through.

It's very common for different domainID to be used for separate brands within a single account.

Getting the customers information

The first step is to retrieve the primary customer interaction which is paying for gift vouchers which creates orders, the checkout is always a guest checkout and there is no concept of registered users.

Retrieve all orders starting with the most recent first using the list orders endpoint. The list endpoint includes all the customer information that the order object contains.

Important

If your intending to send marketing to the customer make sure you check the `marketingOptedIn` boolean attribute on an order to see if a customer has opted in to receive marketing communication at the time of purchase.

Understanding the data

The first thing to understand is the property and locations structure of the account.

An account can have multiple properties setup, all for the same brand, more separate brands, or a mixture of both depending on the desired outcome. While it is often the case that a property is linked to a specific brand, there can be properties that represent a shared parent group brand or a sub-brand within an overall clients business.

A customers order is attached to only one property.

Flow of new customer data

Subsequent requests can be made to the same list orders endpoint filtering on the changed attribute to ensure that you only receive new or modified orders since the last request.

Remember the same customer can (Hopefully) buy your vouchers again and again.