SPOT Master Token Reference List
  • 19 Apr 2024
  • 8 Minutes to read
  • Dark
    Light
  • PDF

SPOT Master Token Reference List

  • Dark
    Light
  • PDF

Article summary

All tokens listed here are proceeded by an '@' symbol when used in a template. Example: Token 'ADDRESS1' would be used as '@ADDRESS1' in the template.

Customer

@2DBARCODECUSTOMERID : This is a QR code, for use to identify the customer. Customer View > Details > ID

@ADDRESS1 : This is the first address listed for a customer in customer view. Customer View > General > Address

@ADDRESS2 : This is the second address listed for the customer in the customer view. Customer View > General > Address (Second listed)

@CHARITYPROGRAM : Charity program assigned to the customer.

@CITY : City listed for the customer. Customer View > Details

@CONTACT : Business customer “Contact” name.

@CREDIT : Customer’s available cash credit.

@CUSTOMERBIRTHDAY : Birthday listed for the customer. Customer View > Details > Dates > (Birthday listed.)

@CUSTOMERGUID : ClientAccount.InstanceID GUID.

@CUSTOMERID : ClientAccount.LexicalKey, which is displayed in Customer View as “ID” and generally referred to as the Customer ID.

@CUSTOMERSIGNUP : Customer Signup date. Customer View > Details > Dates > (Signup date listed.)

@CUSTOMFIELDx : Shorthand for one of: CUSTOMFIELD1, CUSTOMFIELD2, CUSTOMFIELD3, CUSTOMFIELD4, etc. Each is replaced with the value of the custom field in order listed on Customer View > Details. (Order is controlled by arranging them in the Custom Fields collection in Setup > Program Configuration > Company > Customer Settings).

@EMAIL : Customers Email listed. Customer View > General > Email

@EMAIL2 : Additional Email listed for the customer. Customer View > General > More Email addresses > Email2

@FIRSTNAME : Listed first name of the customer. Customer View > General > First Name

@HOTELGUESTNAME : The guest name or room number entered when detailing a hotel invoice. Of course the message must have an associated hotel invoice.

@HOTELROOMNUMBER : The guest name or room number entered when detailing a hotel invoice. Of course the message must have an associated hotel invoice.

@ID : Customer ID. Customer View > General > ID

@INVITATIONCODE : Code generated from customer view. Customer View > General > Invitation code

@LASTNAME : Listed last name of the customer. Customer View > General > Last Name

@LOCKERPIN : Customer locker pin. Customer View > Details > PIN:

@PHONE : Listed phone number for the customer. Customer View > General > Phone 1

@PHONEMOBILE : Listed mobile phone number for the customer. Customer View > General > More Phones… > (First listed 'Mobile' type.)

@PHONEOTHER : Listed 'other' phone number for the customer. Customer View > General > More Phones… > (First listed 'Other' type.)

@PHONEPAGER : Listed pager phone number for the customer. Customer View > General > More Phones… > (First listed 'Pager' type.)

@PHONESMS : Listed mobile phone number for the customer. Customer View > General > More Phones… > (First listed 'Mobile' type.)

@PHONEWORK : Listed work phone number for the customer. Customer View > General > More Phones… > (First listed 'Work' type.)

@POSTALCODE : Zip code for listed for the customer. Customer View > General > Zip

@REWARDID : Name of the reward program listed for the customer. Customer View > Details > (Rewards program selected.)

@REWARDSBALANCE : Current point total for the rewards program listed for the customer. Customer View > Details > (Rewards program) > Points Accrude:

@STATE : Listed state of the customer. Customer View > General > State

@ZIP : Listed customer zip. Customer View > General > Zip Code

Invoice/Vist

@BALANCE : Any unpaid amount in a visit.

@DELIVERYINVOICES : Available from the Orders Delivered scheduled task. Gives the delivered invoices formatted in HTML.

@DEPARTMENTGROUPNAME : Department group name of the associated invoice, if in a context that has an associated invoice.

@DETAILINVOICES : Available from the Orders Delivered scheduled task. Gives the delivered invoices formatted in HTML.

@INDIVIDUALINVOICE : Invoice for a single invoice visit.

@INDIVIDUALVISIT : The invoices making up the visit.

@INVOICENUMBER : The invoice number of the associated invoice.

@ITEMLIST : List of counts, by DepartmentName/CategoryName/ItemName, separated by <br>.

@ORDERS : Count of orders in the visit.

@PIECES : Number of garments in the orders in the visit.

@PNPBALANCE : Amount of the orders the customer was allowed to pickup without paying.

@PNPORDERS : Comma separated list of orders the customer was allowed to pickup without paying.

@PRICE : Total price of the orders making up the visit.

@PROMISEDDATE : Promised date of the associated invoice(s). (Includes time.)

@PROMISEDDATENOTIME : Promised date of the associated invoice(s). (excludes time.)

@RACKEDINVOICES : Gives the racked/ready invoices formatted in HTML.

@RACKLOCATION : Rack location of the associated invoice.

@READYINVOICES : Gives the racked/ready invoices formatted in HTML.

@TAGLIST : List of all item tag values in the associated invoice. Technically usable with a visit but will only display for one of the invoices.

@TOTALDUE : Any unpaid amount in a visit.

Store

@ACCOUNTNODEID : The SPAccountNode.InstanceID GUID for the store.

@CLERK : First name of the SPOT user logged into the SPOT session that triggered the email

@CLERKFULLNAME : Full name of the SPOT user logged into the SPOT session that triggered the email

@STOREADDRESS1 : Listed Store address. Setup > Location Information > Store Addresses > (Type)Physical > Address 1

@STOREADDRESS2 : Listed Store address 2. Setup > Location Information > Store Addresses > (Type)Physical > Address 2

@STOREADDRESSEE : Listed Store addressee. Setup > Location Information > Store Addresses > (Type)Physical > Addressee

@STORECITY : Listed Store city. Setup > Location Information > Store Addresses > (Type)Physical > City

@STORECONTACT : Listed Store contact. Setup > Location Information > Contact

@STOREEMAIL : Listed Store email. Setup > Location Information > Email Address

@STOREFAX : Listed Store fax. Setup > Location Information > Store Addresses > (Type)Physical > Fax

@STOREHOURS : Listed Store hours. Setup > Location Information > Hours of Operation

@STORENAME : Listed Store name. Setup > Location Information > Store Name

@STORENUMBER : Listed Store number. Setup > Location Information > Store number

@STOREPHONE : Listed Store phone. Setup > Location Information > Store Addresses > (Type)Physical > Phone

@STORESTATE : Listed Store state. Setup > Location Information > Store Addresses > (Type)Physical > State

@STOREWEBSITE : Listed Store website. Setup > Location Information > Web Site

@STOREZIP : Listed Store zip. Setup > Location Information > Store Addresses > (Type)Physical > Zip

Company

@COMPANYADDRESS1 : Address listed for the company. Setup > Location Information > Company > Adress1

@COMPANYADDRESS2 : Second address listed for the company. Setup > Location Information > Company > Adress2

@COMPANYCITY : City listed for the company. Setup > Location Information > Company > City

@COMPANYCONTACT : Contact listed for the company. Setup > Location Information > Company > Contacts.. > (Contact listed as primary)

@COMPANYEMAIL : Email listed for the company. Setup > Location Information > Company > Contacts.. > (Contact listed as primary, email)

@COMPANYNAME : Name listed for the company. Setup > Location Information > Company > Name

@COMPANYPHONE : Phone listed for the company. Setup > Location Information > Company > Phone#

@COMPANYSTATE : State listed for the company. Setup > Location Information > Company > State/Province

@COMPANYZIP : Zip listed for the company. Setup > Location Information > Company > Zip Code

Route

@DELIVERYIMAGE : The delivery image recorded by the route driver using Delivery Connect Mobile for the invoices associated with the email.

@DRIVER : Name of the 'driver settings' listed. Setup > Program Configuration > Store > Route Settings > Drivers > (Driver) > Name

@DRIVEREMAIL : Driver Email listed. Setup > Program Configuration > Store > Route Settings > Drivers > (Driver) > Driver Email Address

@DRIVERNAME : Driver name listed. Setup > Program Configuration > Store > Route Settings > Drivers > (Driver) > Driver Display Name

@DRIVERPHONE : Driver phone listed. Setup > Program Configuration > Store > Route Settings > Drivers > (Driver) > Driver phone Address

@ROUTEADDRESS1 : Listed route address 1 for a customer. Customer View > General > More Adresses… > (First listed 'Route' type. Address1.)

@ROUTEADDRESS2 : Listed route address 2 for a customer. Customer View > General > More Adresses… > (First listed 'Route' type. Address2.)

@ROUTECITY : Listed route city for a customer. Customer View > General > More Adresses… > (First listed 'Route' type. City.)

@ROUTENAME : Route name of the route the customer belongs to.

@ROUTEPOSTALCODE : Listed route postal code for a customer. Customer View > General > More Adresses… > (First listed 'Route' type. Zip Code.)

@ROUTESTATE : Listed State for the route assigned to the customer.

@ROUTEZIP : Listed route zip for a customer. Customer View > General > More Adresses… > (First listed 'Route' type. Zip Code.)

Locker

@LOCKERS : Comma separated list of locker numbers to which a locker order was delivered.

@LOCKERBANK : The name of the locker bank to which a locker order was delivered. If the operator is wise the banks will be named after where they are located.

@LOCKERINVOICES : The string "The following order(s) are available for locker pickup: " followed by a list of locker numbers and invoice numbers.

Payment

@PAYMENTAMOUNT : Amount of the payment.

@PAYMENTAMT : Replaced with the amount of the payment that declined.

@PAYMENTAUTHORIZATION : Authorization code of the payment, it applicable, otherwise the hard coded string “N/A”

@PAYMENTDATE : The formats specified in the SPOT Locality definition selected in Location Information > Store are used.

@PAYMENTDETAIL : Credit card last 4 digits for a credit card payment, nothing for other payment types.

@PAYMENTINVOICES : Comma separated list of invoices, such as: 03-100020, 03-100032, 03-100019, 03-100031, 05-100007

@PAYMENTTENDER : Substituted with an abbreviated form of the tender type or credit card type.

Credit Card

@CCEXP : CCOF expiration date

@CCEXPIRE : CCOF expiration date

@CCINFO : Combination of CCTYPE and CCLASTFOUR

@CCLASTFOUR : Last 4 digits of CCOF

@CCTYPE : CCOF type (VISA, MC, AMEX, etc)

A/R

@ACCTBALANCE : This is the posted account balance for the customer. Customer View > A/R - CC > Posted Aging

@ARMASTERACCOUNT : This will list the customer name found in customer view for the master account. Customer View > General > Last, First/Company

@ARSTATEMENTDATE : This is the closing date of the AR Statement

@ARSTATEMENTINVOICES : The invoices associated with an AR statement

@BILLEDACCTBALANCE : This is the billed account balance for the customer. Customer View > A/R - CC > Billed Aging

Misc

@COMMENTS : Value of the comment section of SPOT Schedular.

@DATE : Current date without the time.

@DATETIME : The formats specified in the SPOT Locality definition selected in Location Information > Store are used.

@TRACKINGGROUPID : The unique identifier of the marketing campaign associated with this message, if any.

@TRACKINGURL : Value of Setup > Program Configuration > Store > Email Settings > Tracking URL

@UNSUBSCRIBETEMPLATE : Contents of Setup > Program Configuration > Store > Email Settings > Unsubscribe Message File (HTML)

@UNSUBSCRIBEURL : Value of Setup > Program Configuration > Store > Email Settings > Unsubscribe URL

@UPDATELINK : Generates a link to the API that if followed prompts the customer to update their CCOF.


Was this article helpful?