Cart Updated Event

A Braze recommended eCommerce event for replacing the user's current cart state.

Code Example

braze.logCustomEvent("ecommerce.cart_updated", {
  "cart_id": "cart_abc123",
  "action": "replace",
  "total_value": 234.96,
  "subtotal_value": 219.97,
  "tax": 9,
  "shipping": 5.99,
  "currency": "USD",
  "products": [
    {
      "product_id": "SKU-RUN-4821",
      "product_name": "Ultraboost Running Shoe",
      "variant_id": "UB-BLK-11",
      "image_url": "https://cdn.example.com/shoes/ub-blk-11.jpg",
      "product_url": "https://www.example.com/products/ultraboost-running-shoe",
      "quantity": 1,
      "price": 189.99
    }
  ],
  "source": "web"
});

Event Properties

Property	Type	Constraints	Examples	Description
event	string	required	"ecommerce.cart_updated"	The Braze recommended event name for cart updates.
		const: "ecommerce.cart_updated"
cart_id	string	required	"cart_abc123" "cart_456"	The unique identifier for the cart.
action	string	required	"replace"	The cart update mode.
		const: "replace"
total_value	number	required	234.96 84.99	The total monetary value of the full cart.
subtotal_value	number		219.97 74.99	The cart subtotal after discounts and before tax or shipping.
tax	number		9 5	The total tax applied to the cart.
shipping	number		5.99 5	The shipping cost applied to the cart.
currency	string	required	"USD" "EUR"	The ISO 4217 three-letter currency code.
		minLength: 3
		maxLength: 3
[]products	array	required		The line items in the full cart.
		minItems: 1
product_id	string	required	"SKU-RUN-4821" "sku_2001"	The unique product identifier.
product_name	string	required	"Ultraboost Running Shoe" "Trail Runner Pro"	The product display name.
variant_id	string	required	"UB-BLK-11" "var_2001_black_10"	The product variant identifier.
image_url	string		"https://cdn.example.com/shoes/ub-blk-11.jpg"	The product image URL.
product_url	string		"https://www.example.com/products/ultraboost-running-shoe"	The product page URL.
quantity	integer	required	1 2	The number of units in the cart for this line.
		minimum: 1
price	number	required	189.99 94.99	The product variant unit price.
source	string	required	"web"	The source the event originates from.
		const: "web"

View Raw JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://tracking-docs-demo.buchert.digital/schemas/1.3.0/braze/cart-updated-event.json",
  "title": "Cart Updated Event",
  "description": "A Braze recommended eCommerce event for replacing the user's current cart state.",
  "x-tracking-targets": [
    "web-braze-js"
  ],
  "x-method": "track",
  "type": "object",
  "properties": {
    "event": {
      "type": "string",
      "const": "ecommerce.cart_updated",
      "description": "The Braze recommended event name for cart updates."
    },
    "cart_id": {
      "type": "string",
      "description": "The unique identifier for the cart.",
      "examples": [
        "cart_abc123",
        "cart_456"
      ]
    },
    "action": {
      "type": "string",
      "description": "The cart update mode.",
      "const": "replace"
    },
    "total_value": {
      "type": "number",
      "description": "The total monetary value of the full cart.",
      "examples": [
        234.96,
        84.99
      ]
    },
    "subtotal_value": {
      "type": "number",
      "description": "The cart subtotal after discounts and before tax or shipping.",
      "examples": [
        219.97,
        74.99
      ]
    },
    "tax": {
      "type": "number",
      "description": "The total tax applied to the cart.",
      "examples": [
        9,
        5
      ]
    },
    "shipping": {
      "type": "number",
      "description": "The shipping cost applied to the cart.",
      "examples": [
        5.99,
        5
      ]
    },
    "currency": {
      "type": "string",
      "description": "The ISO 4217 three-letter currency code.",
      "minLength": 3,
      "maxLength": 3,
      "examples": [
        "USD",
        "EUR"
      ]
    },
    "products": {
      "type": "array",
      "description": "The line items in the full cart.",
      "minItems": 1,
      "items": {
        "type": "object",
        "properties": {
          "product_id": {
            "type": "string",
            "description": "The unique product identifier.",
            "examples": [
              "SKU-RUN-4821",
              "sku_2001"
            ]
          },
          "product_name": {
            "type": "string",
            "description": "The product display name.",
            "examples": [
              "Ultraboost Running Shoe",
              "Trail Runner Pro"
            ]
          },
          "variant_id": {
            "type": "string",
            "description": "The product variant identifier.",
            "examples": [
              "UB-BLK-11",
              "var_2001_black_10"
            ]
          },
          "image_url": {
            "type": "string",
            "description": "The product image URL.",
            "examples": [
              "https://cdn.example.com/shoes/ub-blk-11.jpg"
            ]
          },
          "product_url": {
            "type": "string",
            "description": "The product page URL.",
            "examples": [
              "https://www.example.com/products/ultraboost-running-shoe"
            ]
          },
          "quantity": {
            "type": "integer",
            "description": "The number of units in the cart for this line.",
            "minimum": 1,
            "examples": [
              1,
              2
            ]
          },
          "price": {
            "type": "number",
            "description": "The product variant unit price.",
            "examples": [
              189.99,
              94.99
            ]
          }
        },
        "required": [
          "product_id",
          "product_name",
          "variant_id",
          "quantity",
          "price"
        ]
      }
    },
    "source": {
      "type": "string",
      "description": "The source the event originates from.",
      "const": "web"
    }
  },
  "required": [
    "event",
    "cart_id",
    "action",
    "total_value",
    "currency",
    "products",
    "source"
  ]
}