salesbuilder.active Schema

Details of an active sale. This schema cannot be fed into any other salesbuilder APIs, it is a brief summary of a sale.

Example

{
    physkey:    "AKAKADVHFHJDJGJGJGHV2Q34B",
    random_key: "K29B27ER92B81Zxi92ei*gHj27492vBnJ"
}

Field	Description
physkey	A unique identifier for this sale. This will be unique over all stores and lanes. Technically it is not a random value, but contains information to ensure database storage will cluster records together. This value is what is used to identify sales, and is used in the "k" field for salesbuilders.
random_key	A completely random identifier assigned to this sale. This is not used in salesbuilder. It is provided if you need to send the sale identifier to external systems without exposing any details. This field is used within customer displays for example in order to use a totally random token.
datetime_local	The current local datetime for the sale. This is taken from the computer, it is not an attribute of the sale itself. It is not returned for remote or cloud based servers, only instore applications
saletotal	The total amount of the sale. The sum of the items being purchased
physkey_random_no	A short number derived from physkey. This is will repeat over multiple sales. It is intended to aid users finding sales.
physkey_random_no_word	A word representation of physkey_random_no. Each no field has a matching unique no_word value.