Loading...
Area: Episerver Perform, Episerver Reach
Applies to versions: 1.0 and higher (Server-to-Server API)

Checkout page tracking request

The checkout page is similar to the basket page tracking request with additional properties including  subtotal, shipping, and total value of the basket. These values should match what the user sees. That is, if any discounts or surcharges are applied at the order level, include them in the relevant values in the tracking data provided.

NameDescriptionUsage
checkout Element containing checkout-specific sub-elements.  
      items List of checkout items.  
       

refCode

 

Product reference code.

The refCode must exactly match the refCode (guid) specified in the product catalog feed. Also, if you have a custom feed, contact Episerver to find out which field from the feed is used as a product identifier.

    qty Quantity. [Number]
    price Unit price. [Number]
    variant The product variant’s SKU code. Alternatively, you can supply the product variant’s attributes colour and size. By arrangement with Episerver, these can be replaced with another product attribute.

[Optional]

Sub-elements are of the type [String].

Available from version 1.3 of the Server-to-Server API.

See the Variant tracking section.

  currency Currency code. See Currency codes.
  subtotal Subtotal amount. [Number]
  shipping Shipping cost. [Number]
  total Total amount of the checkout. [Number]

Checkout page tracking request example.

{	
	"type"		:	"checkout",
	"ip"		:	"10.42.37.139",
	"session"	:	"155780550/hKugo5RQsqecUpmlWE6EpFWqmalVrJU",
	"cuid"		:	"143159800/hKugo5RQsqecUpmlWE6Eo1OklrJYp5U",
	"site"		:	"retailer",
	"clientToken"	:	"1234abcd5678",
	"channel"	:	"web",
	"lang"		:	"en-gb",
	"currentURI"	:	"www.retailer.com/checkout.html",
	"previousURI"	:	"www.retailer.com/basket.html",
	"userAgent"	:	"Mozilla/5.0 (Windows NT 10.0; WOW64)
           AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36",
	"checkout"	: {
		"items"	: [
			{ "refCode":  "RC123", "qty":  5,  "price":  50.5 },
			{ "refCode":  "RC124", "qty":  8,  "price":  52.5 }
		],
		"currency"	:	"GBP",
		"subtotal"	:	103,	
		"shipping"	:	11.75,
		"total"	        :	114.75
	}		
}

Last updated: Nov 06, 2017

Feedback?