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:

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

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

FieldRequiredTypeDefaultExampleDescription
clientIdstring"velocidi"The client identifier.
siteIdstring"velocidi.com"The client's site identifier.
typerequired"checkoutStep""checkoutStep"The event type.
customFieldsobject 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.
facebookConversionTrackingFacebook Conversion Tracking Details{...}A description of a tracking event to send to Facebook using Facebook Conversions API.
stepstring"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.

FieldRequiredTypeDefaultExampleDescription
pixel_idstring"396622227884531"The pixel ID to associate this Facebook tracking event with.
event_idstring"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_namestring"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_dataobject{...}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.
Last updated on