---
title: "Customers"
canonical: "https://red-ant-documentation.refined.site/space/RET/33783809/Customers"
format: markdown
---
> Macro (toc)

## Overview

Sales associates can access the retailer's customer base through the 'Customers' app. This enables them to get a complete view of each customer, including purchase history, wish lists, sizing, preferences, communications, and much more.

> ⚠️ ‘Temporary Workers’ do not have access to the ‘Customers’ app.

## Customers Structure

The customer records are defined using the following entities:

| **Table** | **Additional Info** |
| --- | --- |
| Customers | The customer record |
| Customer Marketing Stores | The stores that the customer has consented to receive marketing communications from |
| Customer Relationships | Defines which users “follow” which customers |

### Customers 

<details>
<summary>Customers - Data Structure</summary>

| **Field** | **Definition** | **Format / Additional Info** |
| --- | --- | --- |
| `externalCustomerId` | A unique customer ID |  |
| `title` | Customer title |  |
| `gender` | Used to capture the gender of the customer | By default we suppress this field from the customer profile |
| `firstName` | Customer first name |  |
| `lastName` | Customer last name |  |
| `telephone` | Customer telephone number including the country code |  |
| `email` | Customer email |  |
| `dob` | Customer date of birth | dd/mm/yyyy |
| `address` | The customers address. This can include:<br>`city`  
`county`  
`country`  
`address1`  
`address2`  
`postCode` | By default the customer address is pulled through to the delivery address fields within the checkout |
| `details` | This can include:<br>`wishlist` - List of the product IDs that are in the customers wishlist<br>`recommendedProducts` - List of product IDs that are in the customers recommended products<br>`loyaltyType` - The customers loyalty tier<br>`apparelSize` / `footwearSizing` / `jewellerySizing` / `generalPreference` - OOTB list of customer preference<br>`preferredLanguage` - The customers preferred language | `preferredLanguage` - Must be a valid [locale ID](https://learn.microsoft.com/en-us/openspecs/office_standards/ms-oe376/6c085406-a698-4e12-9d4d-c3b0ee3dbc4a) |
| `generalMarketing` | Defines whether the customer has opted into receive general marketing | Boolean - `TRUE` / `FALE` |
| `thirdPartyMarketing` | Defines whether the customer has opted into receive third-party marketing | Boolean - `TRUE` / `FALE` |
| `storeMarketing` | Defines whether the customer has opted into receive store specific marketing | Boolean - `TRUE` / `FALE` |
| `smsMarketing` | Defines whether the customer has opted into receive SMS communications | Boolean - `TRUE` / `FALE` |
| `emailMarketing` | Defines whether the customer has opted into receive Email communications | Boolean - `TRUE` / `FALE`<br>Customer will still receive transactional emails (e.g. order confirmations, consultation summary) if they are opted out of email marketing |
| `whatsappMarketing` | Defines whether the customer has opted into receive WhatsApp communications | Boolean - `TRUE` / `FALE` |
| `postMarketing` | Defines whether the customer has opted into receive communications via Post | Boolean - `TRUE` / `FALE` |
| `phoneMarketing` | Defines whether the customer has opted into receive communications via Phone | Boolean - `TRUE` / `FALE`<br>By default we suppress this field from the customer registration form and full customer profile |
| `reporting` |  |  |
| `registeredById` | The ID of the user who registered the customer | This field is typically empty if the customer records have been imported or fetched from the retailers CRM |
| `registeredAtId` | The ID of the store where the customers profile was registered | This field is typically empty if the customer records have been imported or fetched from the retailers CRM |
| `anonymised` | Defines whether the customer record has been anonymised | Boolean - `TRUE` / `FALE`<br>If customer record has been anonymised, all PII (personally identifiable information) is anonymised (e.g. all personal details, email address, telephone number etc.) |
| `regionId` | The region that the customer record resides in | If territory is being used to segregate customer data then this field will be empty |
| `territoryId` | The territory that that customer  record resides in | Territory is typically used to segregate customer data |
| `notes` | The customer notes that have been created by sales associates | This includes:<br>`note` - The body of the note<br>`user` The ID of the user who created the note<br>`name` - The name of the user who created the note<br>`roleName` - The role of the user who created the note<br>`timestamp` - The date and time of when the note was created |
| `updateSource` | The last application to update the record | Alphanumeric string |
</details>

### Customer Marketing Stores

<details>
<summary>Customer Marketing Stores</summary>

| **Field** | **Definition** | **Format / Additional Info** |
| --- | --- | --- |
| `storeId` | The ID of the store that the customer has consented to receive marketing communications from |  |
| `customerId` | The ID of the customer who has consented to receive store-sepecific marketing communications |  |
</details>

### Customer Relationships

<details>
<summary>Customer Relationships - Data Structure</summary>

| **Field** | **Definition** | **Format / Additional Info** |
| --- | --- | --- |
| `userId` | The ID of the user who is following the customer |  |
| `customerId` | The ID of the customer who is |  |
| `relationshipType` | Defines the user / customer relationship | By default this value will be set to `follow` |
| `id` | A unique user / customer relationship ID |  |
</details>

## Learn more

- [Register Customer](https://redantdigital.atlassian.net/wiki/spaces/RET/pages/379650123)
  - [Contactless Self-Registration](https://redantdigital.atlassian.net/wiki/spaces/RET/pages/553385997)
- [Client Book V1](https://redantdigital.atlassian.net/wiki/spaces/RET/pages/380141650)
- [Client Book V2](https://redantdigital.atlassian.net/wiki/spaces/RET/pages/2526904321)
- [Customer Segmentation](https://redantdigital.atlassian.net/wiki/spaces/RET/pages/2492760065)
- [Customer Profile](https://redantdigital.atlassian.net/wiki/spaces/RET/pages/378503561)
- [GDPR Compliance](https://redantdigital.atlassian.net/wiki/spaces/RET/pages/380010545)