Basket Tracking Methods

This page details the available methods in the Basket Tracking script.

Description of Fields

Basket

Name	Type	Description
customer_id	int	This is the ID for the customer space on the system. This is used to identify which customer space the requests are relevant to.
recipient	string	This is the email address of the recipient who is currently using the e-commerce system. This is used to identify the recipient to whom the triggered emails will be sent, and whose profile information is created.
token	string	This security token is the unique hash created for each recipient. The section on #Creating the Token shows how to get this field.
basket_type_id	int	This field identifies the basket type for customer spaces with more than one type of basket. If a customer space only has one type of basket, this will be 1.
stage	string	The stage is a string representing the current stage in the process of the e-commerce system. Stages are set by customers on the basket type, and the last stage is always 'complete'.
total_value	decimal (2 d.p.)	The total value of all of the items within the basket. As it cannot be assumed that the total value of the basket is always the sum of the values of all of the items (due to the possibility of discounts/promotions etc.) this field is used to give a total value for the basket to be used in gathering statistics. This field is always optional, but if it is used, it should be set with every request.
custom_fields	object	The custom fields are given as an object literal containing any additional fields that need to be set on a basket.
items	array	The array of items currently in the basket. All fields are optional, though providing either a product name or product code would prove useful as a unique identifier for each item. The fields that can be set on an item are shown below.

Items

Name	Type
name	string (255 max chars)
quantity	int
value	decimal (2 d.p.)
product_code	string (255 max chars)
description	string
custom_fields	object

clearItems

Mxm.Basket.clearItems( Object data )

This method sends a request to the system.

Used to clear the items in the basket. 'data' is an object literal containing the following fields:

stage^†
customer_id^†
token^†
recipient^†
basket_type_id^†
total_value^†
custom_fields^†

stage is optional, though it cannot be set in the defaults. If stage is not given, the stage provided in the last request is used. If there was no last request, this method will throw an exception.

getBasketTypeId

Number Mxm.Basket.getBasketTypeId( )

Gets the current basket_type_id in the defaults. If not set, uses default of 1.

getCustomerId

Number Mxm.Basket.getCustomerId( )

Gets the current customer_id in the defaults if set, null if not set.

getCustomFields

Object Mxm.Basket.getCustomFields( )

Gets the current custom_fields in the defaults if set, null if not set.

getDefaults

Object Mxm.Basket.getDefaults( )

Returns an object literal containing the defaults.

getItems

Array Mxm.Basket.getItems( )

Gets the current items in the basket.

getRecipient

String Mxm.Basket.getRecipient( )

Gets the current recipient in the defaults if set, null if not set.

getStage

String Mxm.Basket.getStage( )

Gets the current stage in the defaults if set, null if not set.

getToken

String Mxm.Basket.getToken( )

Gets the current token in the defaults if set, null if not set.

getTotalValue

Number Mxm.Basket.getTotalValue( )

Gets the current total_value in the defaults if set, '0' if not set.

setBasketTypeId

{this} Mxm.Basket.setBasketTypeId( Number id )

Sets the current basket_type_id in the defaults.

setCustomerId

{this} Mxm.Basket.setCustomerId( Number id )

Sets the current customer_id in the defaults.

setCustomFields

Mxm.Basket.setCustomFields( Object fields )

Sets the current custom_fields in the defaults.

Additional fields set via the setCustomFields() method are not visible in the UI. To access them, the below token needs to be placed in your shopping cart snippet: [basket(incomplete):custom.customField]

Example:

var custom = {
 deliveryRate : 10,
 customUrl: oxfordstones.com
}

Mxm.Basket.setCustomFields(custom);

Tokens in Maxemail:

[basket(incomplete):custom.deliveryRate]- in a live email, this token will be converted to '10';

[basket(incomplete):custom.customUrl]- in a live email, this token will be converted to 'oxfordstones.com'.

setDefaults

{this} Mxm.Basket.setDefaults( Object data )

Used to set the defaults for all subsequent requests. An object literal containing any of the fields:

customer_id^†
token^†
recipient^†
basket_type_id^†
total_value^†
custom_fields^†
debug^†

setItems

{this} Mxm.Basket.setItems( Array data )

This method sends a request to the system.

Used to set the items currently in the basket. An object literal containing the following fields:

items
stage^†
customer_id^†
token^†
recipient^†
basket_type_id^†
total_value^†
custom_fields^†

stage is optional, though it cannot be set in the defaults. If stage is not given, the stage provided in the last request is used. If there was no last request, this method will throw an exception.

setRecipient

{this} Mxm.Basket.setRecipient( String recipient )

Sets the current recipient in the defaults.

setStage

{this} Mxm.Basket.setStage( String|Object data )

This method sends a request to the system.

Used to set the current stage of the basket. The argument given can either be the string containing the current stage, or the data object, which is an object literal containing the following fields;

stage
customer_id^†
token^†
recipient^†
basket_type_id^†
total_value^†
custom_fields^†

setToken

{this} Mxm.Basket.setToken( String token )

Sets the current token in the defaults.

setTotalValue

Mxm.Basket.setTotalValue( Number value )

Sets the current total_value in the defaults.

setDebug

Mxm.Basket.setDebug( Boolean enabled )

Sets the debug value in the defaults.

† Fields marked with (†) are optional