Knowledge Base
HomeMain site
HomeMain site
General SetupWebsite Snippets
API Endpoints
General SetupWebsite Snippets
API Endpoints
  1. Ecommerce Events
  • Customer Data
  • Ecommerce Events
    • Product Viewed
    • Product Added to Cart
    • Product Added to Wishlist
    • Product Removed from Cart
    • Cart Viewed
    • Checkout Started
    • Billing Address Added
    • Shipping Details Added
    • Payment Method Selected
    • Checkout Completed
  • Lead Generation Events
    • Lead Create
  1. Ecommerce Events

Shipping Details Added

Definition#

A shipping_details_added event is recorded when a visitor provides shipping information during the checkout process on an e-commerce website.

Usage#

This event is typically implemented in e-commerce tracking setups to monitor the checkout process and gather shipping information. When a visitor enters their shipping address, selects a shipping method, or provides any other relevant shipping details, a shipping_details_added event is triggered.

Common schema#

The event is accompanied by an detail object containing information about the checkout products(s).
The detail object must include the following properties:
detail.currencyrequired
The currency in which the checkout value is expressed (e.g., EUR).
detail.valuerequired
The total value of the checkout event, representing the sum resulting from the current price of each product multiplied by its quantity. (Use dot as decimal separator).
detail.productsrequired
An array containing details of the products in the checkout process. Each product detail is an object with a standard structure.
Expand product object common schema
product

detail.shippingrequired
The shipping details
Expand shipping object common schema
delivery

detail.couponsoptional
An array containing details of the coupons associated with the event.
Expand coupon object common schema
coupon

Example#

Modified at 2025-05-29 10:45:11
Previous
Billing Address Added
Next
Payment Method Selected
Built with