Checkout Step

An event that describes the action of going through a given step in the checkout phase.

Here's an example of a Checkout Step:

Javascript

pcdp("event", "track", {
  "clientId": "kevel",
  "siteId": "kevel.com",
  "type": "checkoutStep",
  "customFields": {
    "debug": "true",
    "role": "superuser"
  },
  "step": "Step 2/5: Fill delivery address"
})

Swift

import VelocidiSDK

let trackingEvent = [
  "clientId": "kevel",
  "siteId": "kevel.com",
  "type": "checkoutStep",
  "customFields": [
    "debug": "true",
    "role": "superuser"
  ],
  "step": "Step 2/5: Fill delivery address"
] as [String: Any]

VSDKVelocidi.sharedInstance().track(trackingEvent, userId: userId)

Kotlin

@import VelocidiSDK;

NSDictionary *trackingEvent = @{
  @"clientId" : @"kevel",
  @"siteId" : @"kevel.com",
  @"type" : @"checkoutStep",
  @"customFields" : @{
    @"debug" : @"true",
    @"role" : @"superuser"
  },
  @"step" : @"Step 2/5: Fill delivery address"
};

[VSDKVelocidi.sharedInstance track: trackingEvent userId: userId]

Java

import org.json.*
import com.velocidi.Velocidi

val trackingEvent = mapOf(
  "clientId" to "kevel",
  "siteId" to "kevel.com",
  "type" to "checkoutStep",
  "customFields" to mapOf(
    "debug" to "true",
    "role" to "superuser"
  ),
  "step" to "Step 2/5: Fill delivery address"
)

Velocidi.getInstance().track(userId, JSONObject(trackingEvent))

Objective-C

import org.json.*;
import com.velocidi.Velocidi;

JSONObject trackingEvent = new JSONObject()
  .put("clientId", "kevel")
  .put("siteId", "kevel.com")
  .put("type", "checkoutStep")
  .put("customFields", new JSONObject()
    .put("debug", "true")
    .put("role", "superuser")
  )
  .put("step", "Step 2/5: Fill delivery address");

Velocidi.getInstance().track(userId, trackingEvent);

In more detail, the fields supported on every Checkout Step are:

Field	Required	Type	Default	Example	Description
clientId		string		"kevel"	The client identifier.
siteId		string		"kevel.com"	The client's site identifier.
type	required	"checkoutStep"		"checkoutStep"	The event type.
customFields		object of string		{...}	An object with custom fields for extra metadata to be supplied in the event. The values within this object must all be strings.
facebookConversionTracking		Facebook Conversion Tracking Details		{...}	A description of a tracking event to send to Facebook using Facebook Conversions API.
step		string		"Step 2/5: Fill delivery address"	An identifier of the step the user is currently going through.

Facebook Conversion Tracking Details

A description of a tracking event to send to Facebook using Facebook Conversions API.

Field	Required	Type	Default	Example	Description
pixel_id		string		"396622227884531"	The pixel ID to associate this Facebook tracking event with.
event_id		string		"0c53d0b57"	ID used to deduplicate events sent by both Facebook Pixel and Conversions API. More information about the usefulness of this ID is available at https://developers.facebook.com/docs/marketing-api/server-side-api/using-the-api/deduplicate-pixel-and-server-side-events.
event_name		string		"AddToCart"	A Facebook pixel Standard Event or Custom Event name. This field is used to deduplicate events sent by both Facebook Pixel and Conversions API. The available Standard Events are listed in https://developers.facebook.com/docs/facebook-pixel/reference#standard-events.
custom_data		object		{...}	Parameters to send additional data Facebook can use for ads delivery optimization. More information about the fields that can be supplied here is available at https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/custom-data.