Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.bspk.com/llms.txt

Use this file to discover all available pages before exploring further.

File PrefixSHOPPER
Current VersionV3
Previous VersionV2 Link to V2 Documentation page
AttributeFormatLengthRequiredDescriptionExample
shopper_refAlphanumeric1-255YesUnique shopper reference descriptor103495
barcodeAlphanumeric1-255NoShopper barcode used for scanning at the cashier/point-of-sale levelSHR-199877-98
profile_typeAlphanumeric1-255NoShopper profule type enum, valid typed: person or organization. When ommited, person is choosed by default.person
first_nameAlphanumeric1-255NoShopper first nameMarie
last_nameAlphanumeric1-255NoShopper last nameCurie
alternate_first_nameAlphanumeric1-255NoShopper other first nameMaria Salomea
alternate_last_nameAlphanumeric1-255NoShopper other last nameSklodowska
genderAlphanumeric1-255NoGender of the client, being: M = Male or F = Female or NB = Non-binaryF
emailAlphanumeric1-255NoShopper emailmarie_curie@email.com
titleAlphanumeric1-20NoShopper titleMr.
mobile_phoneE.1641-255NoShopper mobile phone. Must be unique per shopper+14155551212
other_phoneE.1641-255NoShopper other phone+14155551213
addressAlphanumeric1-255NoShopper address2nd Street
address_2Alphanumeric1-255NoShopper address follow upAppartment 3
address_3Alphanumeric1-255NoShopper address follow upLotissement Vert
address_4Alphanumeric1-255NoShopper address follow upPO Box #123
cityAlphanumeric1-255NoShopper address cityParis
stateAlphanumeric1-255NoShopper address stateIle-de-France
zip_codeAlphanumeric1-255NoShopper address zip code75002
country_codeISO 3166 Must belong to our supported countries2NoShopper address country codeFR
preferencesAlphanumeric, key:value ; separated list1-500NoShopper preferred product categories. Must belong to the company “shopper preferences”, as explained belowprofession:Young Professional,Lawyer
preferred_contact_channelAlphanumeric1-255NoValid entries are chat, email, line, whatsapp, wechat, callwhatsapp
nationalityISO 3166 Must belong to our supported countries2NoShopper nationalityGB
languagesISO 639-1 Must belong to our supported languages. Can be one language or a ; separated list of languages2NoLanguage(s) spoken by shopperfr
email_contactBoolean [TRUE|FALSE]NoDefine if shopper gave their agreement to be contacted by emailTRUE
phone_call_contactBoolean [TRUE|FALSE]NoDefine if shopper gave their agreement to be contacted by phone callFALSE
chat_contactBoolean [TRUE|FALSE]NoDefine if shopper gave their agreement to be contacted by chatTRUE
whatsapp_contactBoolean [TRUE|FALSE]NoDefine if shopper gave their agreement to be contacted by WhatsappTRUE
line_contactBoolean [TRUE|FALSE]NoDefine if shopper gave their agreement to be contacted by LineTRUE
wechat_contactBoolean [TRUE|FALSE]NoDefine if shopper gave their agreement to be contacted by WechatTRUE
do_not_contactBoolean [TRUE|FALSE]NoDefine 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_productsBoolean [TRUE|FALSE]NoDefine if shopper is interested in receiving messages about new productsTRUE
creation_dateDate ISO 860110NoDate when the shopper record was created2022-01-17
store_refAlphanumeric1-255NoShopper record was created at this storeSTORE-1
sales_associate_refAlphanumeric1-255NoShopper’s current associateSALES_ASSOCIATE-1
segmentAlphanumeric1-255NoShopper’s segmentVIP
birthdayDate ISO 8601 (full or partial)10NoShopper’s birthday full date (YYYY-MM-DD) or partial (MM-DD)1980-07-23
passport_numberAlphanumeric1-255NoShopper’s passport numberWWO7288834

​
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 shopper other_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
  • dislike-color: Green, Orange, Blue
Then a shopper can be imported with the following preferences: color:Green,Orange;Black;styles:Vintage;dislike-color:Blue. And shopper preferred product categories will be:
  • color: Green, Orange
  • styles: Vintage
  • dislike-color: Blue
(Black is ignored because it can’t be mapped to any company shopper preferences)

​
Shopper’s Addresses

Important: Once you start importing addresses using the SHOPPER-ADDRESS file, BSPK will ignore any address fields in this file. From that point on, the SHOPPER-ADDRESS file becomes the source of truth for shopper addresses.