Shoppers
File Prefix | SHOPPER |
Current Version | V3 |
Previous Version | V2 Link to V2 Documentation page |
Attribute | Format | Length | Required | Description | Example |
shopper_ref | Alphanumeric | 1-255 | Yes | Unique shopper reference descriptor | 103495 |
first_name | Alphanumeric | 1-255 | No | Shopper first name | Marie |
last_name | Alphanumeric | 1-255 | No | Shopper last name | Curie |
alternate_first_name | Alphanumeric | 1-255 | No | Shopper other first name | Maria Salomea |
alternate_last_name | Alphanumeric | 1-255 | No | Shopper other last name | Sklodowska |
gender | Alphanumeric | 1-255 | No | Gender of the client, being: M = Male or F = Female or NB = Non-binary | F |
Alphanumeric | 1-255 | No | Shopper email | marie_curie@email.com | |
title | Alphanumeric | 1-20 | No | Shopper title | Mr. |
mobile_phone | E.164 | 1-255 | No | Shopper mobile phone. Must be unique per shopper | +14155551212 |
other_phone | E.164 | 1-255 | No | Shopper other phone | +14155551213 |
address | Alphanumeric | 1-255 | No | Shopper address | 2nd Street |
address_2 | Alphanumeric | 1-255 | No | Shopper address follow up | Appartment 3 |
address_3 | Alphanumeric | 1-255 | No | Shopper address follow up | Lotissement Vert |
address_4 | Alphanumeric | 1-255 | No | Shopper address follow up | PO Box #123 |
city | Alphanumeric | 1-255 | No | Shopper address city | Paris |
state | Alphanumeric | 1-255 | No | Shopper address state | Ile-de-France |
zip_code | Alphanumeric | 1-255 | No | Shopper address zip code | 75002 |
country_code | ISO 3166 Must belong to our supported countries | 2 | No | Shopper address country code | FR |
preferences | Alphanumeric ; separated list | 1-255 | No | Shopper preferred product categories. Must belong to the company “shopper preferences”, as explained below | Young Professional; Lawyer |
preferred_contact_channel | Alphanumeric | 1-255 | No | Valid entries are chat, email, line, whatsapp, wechat, call | |
nationality | ISO 3166 Must belong to our supported countries | 2 | No | Shopper nationality | GB |
languages | ISO 639-1 Must belong to our supported languages. Can be one language or a ; separated list of languages | 2 | No | Language(s) spoken by shopper | fr |
email_contact | Boolean [TRUE|FALSE] | No | Define if shopper gave their agreement to be contacted by email | TRUE | |
phone_call_contact | Boolean [TRUE|FALSE] | No | Define if shopper gave their agreement to be contacted by phone call | FALSE | |
chat_contact | Boolean [TRUE|FALSE] | No | Define if shopper gave their agreement to be contacted by chat | TRUE | |
do_not_contact | Boolean [TRUE|FALSE] | No | Define if shopper should not be contacted in anyhow. Once set it will take precedence over the email_contact , phone_call and chat_contact . | FALSE | |
interested_in_new_products | Boolean [TRUE|FALSE] | No | Define if shopper is interested in receiving messages about new products | TRUE | |
creation_date | Date ISO 8601 | 10 | No | Date when the shopper record was created | 2022-01-17 |
store_ref | Alphanumeric | 1-255 | No | Shopper record was created at this store | STORE-1 |
sales_associate_ref | Alphanumeric | 1-255 | No | Shopper’s current associate | SALES_ASSOCIATE-1 |
segment | Alphanumeric | 1-255 | No | Shopper’s segment | VIP |
birthday | Date ISO 8601 (full or partial) | 10 | No | Shopper’s birthday full date (YYYY-MM-DD) or partial (MM-DD) | 1980-07-23 |
passport_number | Alphanumeric | 1-255 | No | Shopper’s passport number | WWO7288834 |
Mobile Phone
Mobile phone will be cleaned and converted to E.164 format. Then we will check if it is a valid mobile phone, and apply the following:
-
If it is a valid mobile phone, it is mapped to shopper
mobile_phone
attribute -
If it is not valid and if shopper
other_phone
is empty, it is mapped to shopperother_phone
attribute -
If it is not valid and shopper
other_phone
is not empty, an error will be raised and shopper won’t be imported
Segment
Segment allows sales associates to assign a client to a CRM segment or to change the current segment of the client. Segment values are specified by the brand. They are imported into BSPK from the brand CRM. A single value can be selected at a time per client.
Migrating from SHOPPER_V2 to SHOPPER_V3?
In the SHOPPER_V3, as mentioned earlier, the segment
column has been repurposed.
Therefore, the column previously known as segment
in SHOPPER_V2 is now referred to as preferences
in SHOPPER_V3, and it should be remapped accordingly.
Preferences
The preferences
column is used to populate shopper’s preferred product categories. If a value corresponds to one of company shopper preferences value, it will be added to shopper preferred product categories. For example if company has the following shopper preferences:
-
color: Green, Orange
-
styles: Modern, Vintage
Then a shopper can be imported with the following preferences: Green;Orange;Black;Vintage
. And shopper preferred product categories will be:
-
color: Green, Orange
-
styles: Vintage
(Black
is ignored because it can’t be mapped to any company shopper preferences)