Clienteling SPI Field Mapping
Use the Clienteling SPI to create, search, update, and retrieve details of a specific customer. This guide summarizes how Clienteling SPI fields map to customer-related information tags. For specification details, see Clienteling SPI.
For more information on tags, read PS Tags.
| PS Tag on Layout | Backend SPI Field | CMS Grouping |
|---|---|---|
| :ps_salutation | profile.salutation | User Profile |
| :ps_customer_name | profile.firstName & profile.lastName | User Profile |
| :ps_first_name | profile.firstName | User Profile |
| :ps_last_name | profile.lastName | User Profile |
| :ps_email | profile.email | User Profile |
| :ps_gender | profile.gender | User Profile |
| :ps_customer_phone | profile.phoneMobile | User Profile |
| :ps_profile_home_phone_number | profile.phoneHome Note: "If configuring this field on any clienteling layouts, the "profile.phoneHome" field should be configured in NetSuite. Alternatively, you can map it to the phone attribute in NetSuite using "profile.phone". | User Profile |
| :ps_birthday | profile.birthday | User Profile |
| :ps_profile_city | profile.address.city | User Profile |
| :ps_profile_country_code | profile.address.countryCode | User Profile |
| :ps_profile_preferred_language | profile.preferredLanguage | User Profile |
| :ps_customer_tax_id | profile.taxInfo.taxId | User Profile |
| :ps_alternate_customer_id | profile.alternateCustomerId | User Profile |
| :ps_num_orders_completed | orderCount | User Profile |
| :ps_num_addresses | addressList | User Profile |
| :ps_num_orders_placed | orderList | User Profile |
| :ps_num_payment_cards | cardList | User Profile |
| :ps_num_wishlist_products | products | User Profile |
| :ps_profile_addressline1 | profile.address.addressLine1 | User Profile |
| :ps_profile_addressline2 | profile.address.addressLine2 | User Profile |
| :ps_profile_city | profile.address.city | User Profile |
| :ps_profile_state | profile.address.state | User Profile |
| :ps_profile_zip | profile.address.postalCode | User Profile |
| :ps_profile_country | profile.address.countryCode | User Profile |
| :ps_profile_address_phone_number | profile.phoneMobile | User Profile |
| consents.newsLetterSignUp | consents.newsLetterSignUp | Form Field |
| consents.eReceipt | consents.eReceipt | Form Field |
| consents.smsSignUp | consents.smsSignUp | Form Field |
| consents.agreeToTC | consents.agreeToTC | Form Field |
| consents.directMailSignUp | consents.directMailSignUp | Form Field |
| consents.phoneSignUp | consents.phoneSignUp | Form Field |
| consents.loyaltySignUp | consents.loyaltySignUp | Form Field |
| :ps_total_store_credit | loyaltyProfile.currentStoreCredit | User Loyalty Profile |
| :ps_current_loyalty_tier_name | loyaltyProfile.currentTier.name | User Loyalty Profile |
| :ps_current_loyalty_tier_title | loyaltyProfile.currentTier.title | User Loyalty Profile |
| :ps_current_loyalty_tier_subtitle | loyaltyProfile.currentTier.subTitle | User Loyalty Profile |
| :ps_current_reward_points | loyaltyProfile.currentPoints | User Loyalty Profile |
| :ps_current_tier_date | loyaltyProfile.currentTier.memberSince | User Loyalty Profile |
| :ps_current_tier_expiry_date | loyaltyProfile.currentTier.expiryDate | User Loyalty Profile |
| :ps_current_loyalty_tier_display | loyaltyProfile.currentTier.display | User Loyalty Profile |
| :ps_next_loyalty_tier_display | loyaltyProfile.nextTier.display | User Loyalty Profile |
| :ps_next_loyalty_tier_name | loyaltyProfile.nextTier.name | User Loyalty Profile |
| :ps_next_loyalty_tier_title | loyaltyProfile.nextTier.title | User Loyalty Profile |
| :ps_total_points | loyaltyProfile.lifetimePoints | User Loyalty Profile |
| :ps_loyalty_custom | loyaltyProfile.customAttributes | User Loyalty Profile |
| :ps_account_number | loyaltyProfile.accountNumber | User Loyalty Profile |
| :ps_num_cash_rewards | loyaltyProfile.cashRewards | User Loyalty Profile |
| :ps_points_to_next_tier | loyaltyProfile.nextTier.points - loyaltyProfile.lifetimePoints | User Loyalty Profile |
| :ps_num_rewards | loyaltyProfile.rewards | User Loyalty Profile |
| :ps_current_credits | loyaltyProfile.currentStoreCredit | User Loyalty Profile |
| :ps_points_to_next_reward | loyaltyProfile.nextRewardPoints - loyaltyProfile.currentPoints | User Loyalty Profile |
| :ps_num_rewards_total | loyaltyProfile.rewards.amount | User Loyalty Profile |
| :ps_num_rewards_total_2 | Sum of loyaltyProfile.rewards[].amount and if loyaltyProfile.rewards.status | User Loyalty Profile |
| :ps_num_rewards_total_2_no_dec | Sum of loyaltyProfile.rewards[].amount and if loyaltyProfile.rewards.status = AVAILABLE | User Loyalty Profile |
| :ps_num_cash_rewards_total_no_dec | Sum of loyaltyProfile.cashRewards.amount if loyaltyProfile.cashRewards.status = AVAILABLE | User Loyalty Profile |
| :ps_num_cash_rewards_total | Sum of loyaltyProfile.cashRewards.amount | User Loyalty Profile |
| :ps_club_contact_id | loyaltyProfile.accountNumber OR loyaltyProfile.loyaltyId | Wine Loyalty |
| :ps_club_id | loyaltyProfile.tierLevelValue | Wine Loyalty |
| :ps_club_membership_id | loyaltyProfile.loyaltyId | Wine Loyalty |
| :ps_club_name | loyaltyProfile.currentTier.name | Wine Loyalty |
| :ps_profile_company | profile.companyName | Wine Loyalty |
| :ps_profile_title | loyaltyProfile.title | Wine Loyalty |