E-Commerce

Last updated 27 days ago

E-Commerce

Product Viewed

Track a product view.

$product -

interface ProductViewed {
  event: 'Product Viewed'
  properties: {
    $product: Product
  }
}

Example

fp360.track('Product Viewed', {
  $product: {
    id: "23489023",
    sku: "23489023",
    name: "Red Shoes",
    categories: [
      "Shoes & Accessories > Shoes",
      "Shoes & Accessories > Shoes > Women Shoes"
    ],
    price: 49.95,
    quantity: 1,
    url: "https://example.com/products/23489023",
    imageUrl: "https://example.com/products/23489023.jpg",
    currency: "USD",
    variant: "Striped",
    color: "Red",
    size: "US 8",
    brand: "Nike"
  }
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Product Viewed",
  "properties": {
    "customProperty": "1",
    "anotherCustomProperty": "Hello",
    "$product": {
      "id": "A0528",
      "sku": "A0528",
      "name": "Stretch Satin Ribbon",
      "price": 7.5,
      "salePrice": 7.5,
      "url": "https://www.mystore.com/product1/",
      "imageUrl": "https://cdn1.mystore.com/image/395x526/product1.jpg",
      "categories": []
    }
  }
}

Product List Viewed

Track that a list of products was viewed. Should be used when a list of products has been shown to the user. Examples are category pages or search results.

$products -

interface ProductListViewed {
  event: 'Product List Viewed'
  properties: {
    $products?: Product[]
  }
}

fp360.track('Product List Viewed', {
  "$products": [
    {
      "id": "23489023",
      "sku": "23489023",
      "name": "Red Shoes",
      "categories": [
        "Shoes & Accessories > Shoes",
        "Shoes & Accessories > Shoes > Women Shoes"
      ],
      "price": 49.95,
      "quantity": 1,
      "url": "https://example.com/products/23489023",
      "imageUrl": "https://example.com/products/23489023.jpg",
      "currency": "USD",
      "variant": "Striped",
      "color": "Red",
      "size": "US 8",
      "brand": "Nike"
    },
    {
      "id": "23489023",
      "sku": "23489023",
      "name": "Red Shoes",
      "categories": [
        "Shoes & Accessories > Shoes",
        "Shoes & Accessories > Shoes > Women Shoes"
      ],
      "price": 49.95,
      "quantity": 1,
      "url": "https://example.com/products/23489023",
      "imageUrl": "https://example.com/products/23489023.jpg",
      "currency": "USD",
      "variant": "Striped",
      "color": "Red",
      "size": "US 8",
      "brand": "Nike"
    }
  ]
)

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "event": "Product List Viewed",
  "properties": {
    "$products": [
      {
        "id": "23489023",
        "sku": "23489023",
        "name": "Red Shoes",
        "categories": [
          "Shoes & Accessories > Shoes",
          "Shoes & Accessories > Shoes > Women Shoes"
        ],
        "price": 49.95,
        "quantity": 1,
        "url": "https://example.com/products/23489023",
        "imageUrl": "https://example.com/products/23489023.jpg",
        "currency": "USD",
        "variant": "Striped",
        "color": "Red",
        "size": "US 8",
        "brand": "Nike"
      },
      {
        "id": "23489023",
        "sku": "23489023",
        "name": "Red Shoes",
        "categories": [
          "Shoes & Accessories > Shoes",
          "Shoes & Accessories > Shoes > Women Shoes"
        ],
        "price": 49.95,
        "quantity": 1,
        "url": "https://example.com/products/23489023",
        "imageUrl": "https://example.com/products/23489023.jpg",
        "currency": "USD",
        "variant": "Striped",
        "color": "Red",
        "size": "US 8",
        "brand": "Nike"
      }
    ]
  }
}

Product Added

Use when a product has been added to cart.

interface ProductAdded {
  event: 'Product Added'
  properties: {
    $cart?: Cart
    $product: Product
  }
}

Example

fp360.track('Product Added', {
    "$cart": {
      "id": "5f26d70f-df43-4f7c-b8b9-fe0b2659575f"
    },
    "$product": {
      "id": "23489023",
      "sku": "23489023",
      "name": "Red Shoes",
      "categories": [
        "Shoes & Accessories > Shoes",
        "Shoes & Accessories > Shoes > Women Shoes"
      ],
      "price": 49.95,
      "quantity": 1,
      "url": "https://example.com/products/23489023",
      "imageUrl": "https://example.com/products/23489023.jpg",
      "currency": "USD",
      "variant": "Striped",
      "color": "Red",
      "size": "US 8",
      "brand": "Nike"
    }
  })

Interface

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Product Added",
  "properties": {
    "$cart": {
      "id": "5f26d70f-df43-4f7c-b8b9-fe0b2659575f"
    },
    "$product": {
      "id": "23489023",
      "sku": "23489023",
      "name": "Red Shoes",
      "categories": [
        "Shoes & Accessories > Shoes",
        "Shoes & Accessories > Shoes > Women Shoes"
      ],
      "price": 49.95,
      "quantity": 1,
      "url": "https://example.com/products/23489023",
      "imageUrl": "https://example.com/products/23489023.jpg",
      "currency": "USD",
      "variant": "Striped",
      "color": "Red",
      "size": "US 8",
      "brand": "Nike"
    }
  }
}

Product Removed

Use when a product has been removed from the cart.

interface ProductRemoved {
  event: 'Product Removed'
  properties: {
    $cart?: Cart
    $product: Product
  }
}

Example

fp360.track('Product Removed', {
  $cart: {
    id: "5f26d70f-df43-4f7c-b8b9-fe0b2659575f"
  },
  $product: {
    id: "23489023",
    sku: "23489023",
    name: "Red Shoes",
    categories: [
        "Shoes & Accessories > Shoes",
        "Shoes & Accessories > Shoes > Women Shoes"
      ],
    price: 49.95,
    quantity: 1,
    url: "https://example.com/products/23489023",
    imageUrl: "https://example.com/products/23489023.jpg",
    currency: "USD",
    variant: "Striped",
    color: "Red",
    size: "US 8",
    brand: "Nike"
  }
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Product Removed",
  "properties": {
    "$cart": {
      "id": "5f26d70f-df43-4f7c-b8b9-fe0b2659575f"
    },
    "$product": {
      "id": "23489023",
      "sku": "23489023",
      "name": "Red Shoes",
      "categories": [
        "Shoes & Accessories > Shoes",
        "Shoes & Accessories > Shoes > Women Shoes"
      ],
      "price": 49.95,
      "quantity": 1,
      "url": "https://example.com/products/23489023",
      "imageUrl": "https://example.com/products/23489023.jpg",
      "currency": "USD",
      "variant": "Striped",
      "color": "Red",
      "size": "US 8",
      "brand": "Nike"
    }
  }
}

Cart Viewed

Add when a cart is viewed. Could be a full page cart view, or a quick cart popup.

interface CartViewed {
  event: 'Cart Viewed'
  properties: {
    $cart: Cart
  }
}

Example

fp360.track('', {
  $cart: {
    id: "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
    revenue: 73.40,
    discount: 10.00,
    discountCode: "10OFF",
    tax: 5.00,
    shipping: 7.00,
    currency: "USD",
    products: [
      {
        id: "23489023",
        sku: "23489023",
        name: "Red Shoes",
        categories: [
          "Shoes & Accessories > Shoes",
          "Shoes & Accessories > Shoes > Women Shoes"
        ],
        price: 49.95,
        quantity: 1,
        url: "https://example.com/products/23489023",
        imageUrl: "https://example.com/products/23489023.jpg",
        currency: "USD",
        variant: "Striped",
        color: "Red",
        size: "US 8",
        brand: "Nike"
      }
    ],
    location: {
      country: "United States",
      countryCode: "US",
      region: "California",
      city: "Palo Alto",
      postalCode: "94301",
      street: "725 Alma Street",
      text: "725 Alma Street, Palo Alto, CA 94301",
      latitude: 37.44178713736534,
      longitude: -122.16064940120228
    }
  }
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Cart Viewed",
  "properties": {
    "$cart": {
      "id": "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
      "revenue": 73.40,
      "discount": 10.00,
      "discountCode": "10OFF",
      "tax": 5.00,
      "shipping": 7.00,
      "currency": "USD",
      "products": [
        {
          "id": "23489023",
          "sku": "23489023",
          "name": "Red Shoes",
          "categories": [
            "Shoes & Accessories > Shoes",
            "Shoes & Accessories > Shoes > Women Shoes"
          ],
          "price": 49.95,
          "quantity": 1,
          "url": "https://example.com/products/23489023",
          "imageUrl": "https://example.com/products/23489023.jpg",
          "currency": "USD",
          "variant": "Striped",
          "color": "Red",
          "size": "US 8",
          "brand": "Nike"
        }
      ],
      "location": {
        "country": "United States",
        "countryCode": "US",
        "region": "California",
        "city": "Palo Alto",
        "postalCode": "94301",
        "street": "725 Alma Street",
        "text": "725 Alma Street, Palo Alto, CA 94301",
        "latitude": 37.44178713736534,
        "longitude": -122.16064940120228
      }
    }
  }
}

Checkout Started

Indicate that checkout has started.

interface CheckoutStarted {
  event: 'Checkout Started'
  properties: {
    $cart: Cart
  }
}

Example

fp360.track('Checkout Started', {
  $cart: {
    id: "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
    checkoutStep: 1
  }
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Checkout Started",
  "properties": {
    "$cart": {
      "id": "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
      "checkoutStep": 1
    }
  }
}

Checkout Step Viewed

Indicate that a checkout step has been viewed.

Interface

interface CheckoutStepViewed {
  event: 'Checkout Step Viewed'
  properties: {
    $cart: Cart
  }
}

Example

fp360.track('Checkout Step Viewed', {
  $cart: {
    id: "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
    checkoutStep: 2
  }
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Checkout Step Viewed",
  "properties": {
    "$cart": {
      "id": "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
      "checkoutStep": 2
    }
  }
}

Checkout Step Completed

Indicate that a checkout step has been completed.

interface CheckoutStepCompleted {
  event: 'Checkout Step Completed'
  properties: {
    $cart: Cart
  }
}

fp360.track('Checkout Step Completed', {
  $cart: {
    id: "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
    checkoutStep: 2
  }
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Checkout Step Completed",
  "properties": {
    "$cart": {
      "id": "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
      "checkoutStep": 2
    }
  }
}

Order Completed

Indicate that an order has been placed.

interface OrderCompleted {
  event: 'Order Completed'
  properties: {
    $order: Order
  }
}

fp360.track('Order Completed', {
  $order: {
    orderNumber: "34859456045",
    cartId: "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
    revenue: 73.40,
    discount: 10.00,
    discountCode: "10OFF",
    tax: 5.00,
    shipping: 7.00,
    currency: "USD",
    products: [
      {
        id: "23489023",
        sku: "23489023",
        name: "Red Shoes",
        categories: [
          "Shoes & Accessories > Shoes",
          "Shoes & Accessories > Shoes > Women Shoes"
        ],
        price: 49.95,
        quantity: 1,
        url: "https://example.com/products/23489023",
        imageUrl: "https://example.com/products/23489023.jpg",
        currency: "USD",
        variant: "Striped",
        color: "Red",
        size: "US 8",
        brand: "Nike"
      }
    ],
    location: {
      country: "United States",
      countryCode: "US",
      region: "California",
      city: "Palo Alto",
      postalCode: "94301",
      street: "725 Alma Street",
      text: "725 Alma Street, Palo Alto, CA 94301",
      latitude: 37.44178713736534,
      longitude: -122.16064940120228
    },
    billingLocation: {
      country: "Australia",
      countryCode: "AU",
      region: "Victoria",
      city: "Melbourne",
      postalCode: "3000",
      street: "152 Elizabeth St",
      text: "152 Elizabeth St, Melbourne, VIC 3000",
      latitude: -37.8146469,
      longitude: 144.9628618
    },
    shippingLocation: {
      country: "Australia",
      countryCode: "AU",
      region: "Victoria",
      city: "Melbourne",
      postalCode: "3000",
      street: "152 Elizabeth St",
      text: "152 Elizabeth St, Melbourne, VIC 3000",
      latitude: -37.8146469,
      longitude: 144.9628618
    }
  }
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Order Completed",
  "properties": {
    "$order": {
      "orderNumber": "34859456045",
      "cartId": "5f26d70f-df43-4f7c-b8b9-fe0b2659575f",
      "revenue": 73.40,
      "discount": 10.00,
      "discountCode": "10OFF",
      "tax": 5.00,
      "shipping": 7.00,
      "currency": "USD",
      "products": [
        {
          "id": "23489023",
          "sku": "23489023",
          "name": "Red Shoes",
          "categories": [
            "Shoes & Accessories > Shoes",
            "Shoes & Accessories > Shoes > Women Shoes"
          ],
          "price": 49.95,
          "quantity": 1,
          "url": "https://example.com/products/23489023",
          "imageUrl": "https://example.com/products/23489023.jpg",
          "currency": "USD",
          "variant": "Striped",
          "color": "Red",
          "size": "US 8",
          "brand": "Nike"
        }
      ],
      "location": {
        "country": "United States",
        "countryCode": "US",
        "region": "California",
        "city": "Palo Alto",
        "postalCode": "94301",
        "street": "725 Alma Street",
        "text": "725 Alma Street, Palo Alto, CA 94301",
        "latitude": 37.44178713736534,
        "longitude": -122.16064940120228
      },
      "billingLocation": {
        "country": "Australia",
        "countryCode": "AU",
        "region": "Victoria",
        "city": "Melbourne",
        "postalCode": "3000",
        "street": "152 Elizabeth St",
        "text": "152 Elizabeth St, Melbourne, VIC 3000",
        "latitude": -37.8146469,
        "longitude": 144.9628618
      },
      "shippingLocation": {
        "country": "Australia",
        "countryCode": "AU",
        "region": "Victoria",
        "city": "Melbourne",
        "postalCode": "3000",
        "street": "152 Elizabeth St",
        "text": "152 Elizabeth St, Melbourne, VIC 3000",
        "latitude": -37.8146469,
        "longitude": 144.9628618
      }
    }
  }
}

Searched

Indicate that a search was made.

interface Searched {
  event: 'Searched'
  properties: {
    $search: Search
  }
}

fp360.track('Searched', {
  $search: {
    query: "red shoes"
  }
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Searched",
  "properties": {
    "$search": {
      "query": "red shoes"
    }
  }
}

Discount Code Added

Indicate that a search was made.

interface DiscountCodeAdded {
  event: 'Discount Code Added'
  properties: {
    $discountCode: string
  }
}

fp360.track('Discount Code Added', {
    $discountCode: '10_OFF'
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Discount Code Added",
  "properties": {
    "$discountCode": "10_OFF"
  }
}

Discount Code Removed

Indicate that a search was made.

interface DiscountCodeRemoved {
  event: 'Discount Code Removed'
  properties: {
    $discountCode: string
  }
}

fp360.track('Discount Code Removed', {
    $discountCode: '10_OFF'
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Discount Code Removed",
  "properties": {
    "$discountCode": "10_OFF"
  }
}

Cart Abandoned

Indicate that a search was made.

interface CartAbandoned {
  event: 'Cart Abandoned'
  properties: {
    $cart: Cart
  }
}

fp360.track('Cart Abandoned', {
    $cart: { ... }
})

Example

{
  ...<EVENT_MESSAGE_PROPERTIES>,
  "type": "track",
  "event": "Cart Abandoned",
  "properties": {
    "$cart": { ... }
  }
}

PreviousSemantic Events NextMessaging

Last updated 27 days ago