Checkout Started
When to Use
This event should be triggered when a visitor initiates the checkout process, providing insights into checkout funnel entry and purchase intent.
Proceed to Checkout Button
When a visitor clicks "Proceed to Checkout", "Buy Now", or similar buttons that start the checkout flow.
Checkout Page Navigation
When a visitor navigates directly to the first step of the checkout process from cart or product pages.
Express Checkout Actions
When fast checkout options like "Quick Buy", "One-Click Purchase", or express payment methods are initiated.
Guest/Member Checkout Selection
When the checkout process begins and users choose between guest checkout or member login options.
Complete Reference
event object required
name string required
Use only static value checkout_started for `event.name'.
name: "checkout_started"
value number required
Event value in decimal format.
Represent the total value of all products entering checkout.
value: 123.99
currency string required
Currency code that specifies the currency in which all monetary values from any object associated with this event are expressed.
Note: This value can be overridden in nested objects if they contain their own value key with a currency specified.
currency: "USD"
exchange_rate number
Custom exchange rate for multi-currency. Default has value 1.
Note: This value can be overridden in nested objects if they contain their own value key with a currency specified.
exchange_rate: 1
id string recommended
Event ID — required for any actions that require deduplication or uniqueness. Represents the unique identifier of an action ID used in your system.
id: "UNIQUE_ACTION_ID_123"
context object
Use only if exists new data. View complete Context Object documentation
url string required-if-applicable
Complete URL of the current page including all parameters
SPA Applications: context.url is particularly valuable for Single Page Applications where URL changes don’t automatically trigger page context updates. Manual implementation ensures accurate tracking of page transitions and user navigation within SPA frameworks.
url:"https://shop.example.com/products/laptop?color=silver&storage=512gb&utm_source=google"
URL Parameter Sensitivity: Be mindful of sensitive information in URLs. Query parameters may contain personal identifiers, session tokens, or private information that should be handled according to privacy regulations.
page_type string recommended
Type of page (product, home ...)
page_type: "product"
environment string recommended
Allowed values: prod, dev
environment: "prod"
products array required
An array containing details of the products in the checkout process. View complete Product Object documentation
products[0] object required
id string required
Unique product identifier in your system.
id: "PRODUCT_ID"
parent_id string required
Parent product ID for variants or child products (can be same as id if no parent concept exists).
parent_id: "PRODUCT_PARENT_ID"
name string required
Product name or title displayed to users.
name: "PRODUCT_NAME"
parent_name string
Parent product name for variants or child products
parent_name: "PRODUCT_PARENT_NAME"
price_base number required
Original or base price before discounts (decimal format: 299.99)
price_base: 120.99
price number required
Current selling price after discounts (decimal format: 249.99)
price: 100.99
tax_included boolean required
Whether the price includes taxes (true/false)
tax_included: true
tax_percent number required
Tax percentage applied to the product (0-100)
tax_percent: 21
quantity number required
Quantity of this product in the context of the event
quantity: 1
category string required
Main product category name
category: "PRODUCT_MAIN_CATEGORY_NAME"
sku string
Product SKU (Stock Keeping Unit) for inventory tracking
sku: "PRODUCT_SKU"
parent_sku string
Parent product SKU for variants or child products
parent_sku: "PRODUCT_PARENT_SKU"
gtin string
Global Trade Item Number for product identification
gtin: "PRODUCT_GTIN"
mpn string
Manufacturer Part Number assigned by the manufacturer
mpn: "PRODUCT_MPN"
ean string
European Article Number for product barcoding
ean: "PRODUCT_EAN"
brand string
Product brand or manufacturer name
brand: "PRODUCT_BRAND"
type string
Product type: "simple", "variable", "virtual", "bundle", "subscription", "external".
Default: simple.
type: "simple"
stock_status boolean recommended
Product availability status (true = in stock, false = out of stock)
stock_status: true
stock_location string
Physical location or warehouse where product is stored
stock_location: "WAREHOUSE_NAME"
created_at string recommended
Timestamp when product was added to inventory (milliseconds)
created_at: 1754926521690
url string
Direct URL to the product page
url: "https://shop.example.com/products/laptop-page"
parent_url string
URL to the parent product page (for variants)
parent_url: "https://shop.example.com/products/laptop-page"
image string
Main product image URL
image: "https://cdn.example.com/products/laptop-image.jpg"
images array
Array of additional product image URLs
images: [
"https://cdn.example.com/products/laptop-image-1.jpg",
"https://cdn.example.com/products/laptop-image-2.jpg",
]
categories array
Array of category objects with name and id properties
- name (string, required) - Category name
- id (string) - Category identifier
categories: [
{
name: "PRODUCT_FIRST_CATEGORY_NAME",
id: "1111"
},
{
name: "PRODUCT_SECOND_CATEGORY_NAME",
id: "1111"
}
]
coupons array
Array of product-level coupons applied to this product. View complete Coupon Object documentation
coupons[0] (object) - required
requiredname string required
Coupon name or code.
name: "FREE SHIPPING"
value number recommended
Coupon discount value.
value: 123.99
tax_included boolean recommended
Whether coupon value includes taxes
tax_included: true
tax_precent string recommended
Tax percentage for the coupon
tax_precent: 21
id string
Coupon internal identifier.
id: "COUPON_INTERNAL_ID"
type string
Coupon type (e.g., "LOYALTY", "SEASONAL", "FIRST_ORDER")
type: "SHIPPING"
currency string required-if-applicable
Currency code. Specifies the currency code when it differs from event.currency.
currency: "USD"
exchange_rate number
Custom exchange rate for multi-currency. Default has value 1. Specifies when it differs from event.exchange_rate.
exchange_rate: 1
properties object recommended
Custom product attributes for audience segmentation. Use custom properties that match your product catalog and business needs.
- color (string|array) - Product color(s): "blue" or ["blue", "navy"]
- size (string) - Product size: "S", "M", "L", "XL"
- material (string|array) - Product material(s): "cotton" or ["cotton", "polyester"]
- connectivity (string|array) - Connection types: "wireless" or ["wifi", "bluetooth"]
- storage (string) - Storage capacity: "256GB", "512GB"
- dimensions (string) - Physical dimensions: "120x60x75cm"
Use the properties object to store custom product attributes, with property names defined by each business as needed, that enable advanced segmentation, personalization, and analytics across your marketing campaigns.
- IT & C
- Fashion
- Deco
properties: {
color: "space_gray",
storage: "256GB",
memory: "16GB",
connectivity: ["wifi", "bluetooth"],
warranty: "2_years",
energy_rating: "A++",
brand_series: "pro_line"
}
properties: {
color: ["black", "white"],
size: "M",
material: "cotton",
fit: "regular",
season: "summer",
collection: "2024_spring",
care_instructions: "machine_wash"
}
properties: {
color: ["natural", "oak"],
dimensions: "120x80x75cm",
material: ["wood", "metal"],
style: "modern",
room_type: ["living_room", "office"],
assembly_required: "true"
}
currency string required-if-applicable
Currency code. Specifies the currency code when it differs from event.currency.
currency: "USD"
exchange_rate number
Custom exchange rate for multi-currency. Default has value 1. Specifies when it differs from event.exchange_rate.
exchange_rate: 1
coupons array
An array containing details of the coupons associated with the event. View complete Coupon Object documentation
coupons[0] object required
name string required
Coupon name or code.
name: "FREE SHIPPING"
value number recommended
Coupon discount value.
value: 123.99
tax_included boolean recommended
Whether coupon value includes taxes
tax_included: true
tax_precent string recommended
Tax percentage for the coupon
tax_precent: 21
id string
Coupon internal identifier.
id: "COUPON_INTERNAL_ID"
type string
Coupon type (e.g., "LOYALTY", "SEASONAL", "FIRST_ORDER")
type: "SHIPPING"
currency string required-if-applicable
Currency code. Specifies the currency code when it differs from event.currency.
currency: "USD"
exchange_rate number
Custom exchange rate for multi-currency. Default has value 1. Specifies when it differs from event.exchange_rate.
exchange_rate: 1
user object recommended
id string recommended
Unique customer identifier in your system.
id: "CUSTOMER_INTERNAL_ID"
email string|array recommended
Customer email address(es) provided in plaintext or as SHA-256 hashed values.
email: "[email protected]"
// or
email: ["[email protected]", "[email protected]"]
// or
email: ["3e1ufd1rdnh8l1rfz6xlreyw2yryd4zrf8zsk1pxh2x8wbsp2mw1g93rs5nx68dq"]
phone string|array recommended
Customer phone number(s) in E.164 format (plaintext) or as SHA-256 hashed values.
phone: "+40712345678"
// or
phone: ["+40712345678", "+4079876543"]
// or
phone: ["unw5r66oikql4n4tlg2c54bkd2npephsbwwhxuoxreu6ph8uv6k424y9x15opy9y"]
first_name string recommended
Customer first name
first_name: "John"
last_name string recommended
Customer last name
last_name: "Doe"
country string
Country name or ISO country code
country: "Romania"
region string recommended
State, province, or region name
region: "Bucuresti"
city string recommended
City or locality name
city: "Bucuresti"
street string
Street address including number
street: "Strada Principala 1"
postal_code string
Postal code or ZIP code
postal_code: "700000"
orders_total_number number recommended
Cumulative number of orders placed by this user
orders_total_number: 5
orders_canceled_number number recommended
Cumulative number of orders placed and canceled by this user
orders_canceled_number: 0
orders_total_value number recommended
Cumulative lifetime user orders value (decimal format: 2500.50)
orders_total_value: 1234.99
orders_refunded_value number recommended
Cumulative lifetime user orders value canceled (decimal format: 2500.50)
orders_refunded_value: 250.99
predicted_value number
Predicted lifetime value of a customer for your business
predicted_value: 100.99
created_at number recommended
Timestamp in milliseconds since Unix epoch representing the first time the user was recorded
created_at: 1754926521690
properties object recommended
Custom Customer Properties Examples
Use the properties object to store custom user attributes, with property names defined by each business as needed, that enable advanced segmentation, personalization, and analytics across your marketing campaigns.
- E-commerce Customer
- B2B Lead/Customer
- Subscription Service
- Content Platform
properties: {
customer_type: "returning",
membership_level: "platinum",
preferred_category: ["electronics", "fashion"],
last_purchase_date: "2024-12-15",
average_order_value: "350.00",
payment_method_preference: "card",
registration_date: "2023-06-15"
}
properties: {
company_size: "enterprise",
industry: "fintech",
job_title: "marketing_director",
decision_maker: "true",
budget_range: "50000-100000",
lead_source: ["linkedin", "webinar"],
qualification_status: "qualified",
sales_stage: "proposal"
}
properties: {
subscription_tier: "premium",
billing_cycle: "annual",
feature_usage: ["analytics", "reporting", "api"],
trial_user: "false",
renewal_date: "2025-06-30",
support_level: "priority",
usage_frequency: "daily"
}
properties: {
content_preferences: ["technology", "business"],
engagement_level: "high",
newsletter_subscriber: "true",
social_media_follower: "true",
content_consumption: "premium",
device_preference: ["mobile", "desktop"],
timezone: "Europe/Bucharest"
}
Object Examples
These examples demonstrate the complete data object structure for the checkout_started event. Use the complete example for detailed implementations or the minimal example for quick integrations.
- Complete Example
- Minimal Example
{
"event": {
"name": "checkout_started",
"value": 1749.97,
"currency": "USD",
"exchange_rate": 1,
"id": "CHECKOUT_START_456789",
"properties": {
"checkout_type": "standard",
"cart_items_count": 3,
"cart_recovery_eligible": true,
"guest_checkout_available": true,
"express_checkout_available": true,
"saved_payment_methods": 2,
"shipping_options_available": 4,
"estimated_tax": 143.73,
"free_shipping_threshold": 2000.00,
"loyalty_discount_eligible": true
}
},
"context": {
"environment": "prod",
"data_source": "website",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36",
"overide_ip": "203.0.113.45",
"url": "https://shop.example.com/checkout/step1",
"landing_url": "https://shop.example.com/fitness/equipment",
"referring_url": "https://google.com"
},
"products": [
{
"id": "FITNESS_BIKE_001",
"parent_id": "FITNESS_BIKE_001",
"sku": "FB-INDOOR-PRO-001",
"parent_sku": "FB-INDOOR-PRO",
"gtin": "3579864201357",
"mpn": "FB-INDOOR-PRO-2024",
"ean": "3579864201357",
"name": "Indoor Cycling Bike Pro",
"parent_name": "Indoor Cycling Bike Pro Series",
"brand": "FitnessTech",
"type": "simple",
"price_base": 1299.99,
"price": 1199.99,
"currency": "USD",
"exchange_rate": 1,
"tax_included": true,
"tax_percent": 8.25,
"quantity": 1,
"stock_status": true,
"stock_location": "Fitness Equipment Warehouse",
"created_at": 1748505040077,
"url": "https://shop.example.com/indoor-cycling-bike-pro",
"parent_url": "https://shop.example.com/indoor-cycling-bike-pro",
"image": "https://cdn.example.com/fitness-bike-pro-main.jpg",
"images": [
"https://cdn.example.com/fitness-bike-pro-side.jpg",
"https://cdn.example.com/fitness-bike-pro-console.jpg",
"https://cdn.example.com/fitness-bike-pro-pedals.jpg"
],
"category": "Fitness > Cardio > Indoor Bikes",
"categories": [
{
"name": "Fitness",
"id": "cat_fitness"
},
{
"name": "Cardio",
"id": "cat_cardio"
},
{
"name": "Indoor Bikes",
"id": "cat_indoor_bikes"
}
],
"properties": {
"resistance_type": "magnetic",
"flywheel_weight": "22kg",
"max_user_weight": "150kg",
"console_features": ["heart_rate", "cadence", "power", "bluetooth"],
"adjustable_seat": "vertical_horizontal",
"adjustable_handlebars": "yes",
"transport_wheels": "yes",
"warranty": "2_years_parts_labor"
}
},
{
"id": "WATER_BOTTLE_SMART_001",
"sku": "WB-SMART-TEMP-001",
"name": "Smart Temperature Water Bottle",
"brand": "HydroSmart",
"type": "simple",
"price": 89.99,
"currency": "USD",
"tax_included": true,
"tax_percent": 8.25,
"quantity": 2,
"stock_status": true,
"category": "Fitness > Accessories > Hydration",
"properties": {
"capacity": "750ml",
"material": "stainless_steel",
"insulation": "double_wall_vacuum",
"smart_features": ["temperature_display", "hydration_reminder"],
"battery_life": "30_days",
"app_connectivity": "yes"
}
},
{
"id": "WORKOUT_MAT_PRO_001",
"sku": "WM-PRO-EXTRA-THICK",
"name": "Extra Thick Workout Mat",
"brand": "YogaPro",
"type": "simple",
"price": 79.99,
"currency": "USD",
"tax_included": true,
"tax_percent": 8.25,
"quantity": 1,
"category": "Fitness > Accessories > Mats",
"properties": {
"thickness": "15mm",
"material": "eco_friendly_tpe",
"size": "183x61cm",
"non_slip": "yes",
"carrying_strap": "included"
}
}
],
"coupons": [
{
"name": "FITNESS_BUNDLE_10",
"value": 200.00,
"currency": "USD",
"tax_percent": 8.25,
"tax_included": true,
"id": "FITNESS_BUNDLE_2024",
"type": "BUNDLE_DISCOUNT"
}
],
"user": {
"id": "CUST_FITNESS_789123",
"email": ["[email protected]"],
"phone": ["+1555666999"],
"first_name": "Rachel",
"last_name": "Williams",
"country": "United States",
"region": "Colorado",
"city": "Boulder",
"street": "456 Mountain View Road",
"postal_code": "80301",
"orders_total_number": 5,
"orders_canceled_number": 0,
"orders_total_value": 2456.87,
"orders_refunded_value": 0,
"predicted_value": 3500.00,
"created_at": 1704067200000,
"properties": {
"customer_segment": "fitness_enthusiast",
"acquisition_channel": "influencer_marketing",
"preferred_categories": ["fitness", "wellness", "sports"],
"communication_language": "en",
"loyalty_tier": "gold",
"account_type": "personal",
"marketing_consent": true,
"checkout_preference": "express"
}
}
}
{
"event": {
"name": "checkout_started",
"value": 199.99,
"currency": "USD",
"id": "CHECKOUT_START_MIN_123"
},
"context": {
"environment": "prod",
"data_source": "website"
},
"products": [
{
"id": "RUNNING_SHOES_001",
"sku": "RS-TRAIL-42",
"name": "Trail Running Shoes Size 42",
"brand": "RunTech",
"type": "simple",
"price": 199.99,
"currency": "USD",
"tax_included": true,
"tax_percent": 8.25,
"quantity": 1,
"category": "Footwear > Running > Trail"
}
]
}
Implementation Methods
These examples show how to send the data objects using different implementation approaches. Choose the method that best fits your technical setup.
- JavaScript Implementation
- API Implementation
// Web tracking implementation
window.reshape = window.reshape || [];
// Send the complete data object
reshape.push({
"event": {
"name": "checkout_started",
"value": 1749.97,
"currency": "USD",
"id": "CHECKOUT_START_456789"
},
"context": {
"environment": "prod",
"data_source": "website"
},
"products": [
{
"id": "FITNESS_BIKE_001",
"sku": "FB-INDOOR-PRO-001",
"name": "Indoor Cycling Bike Pro",
"brand": "FitnessTech",
"price": 1199.99,
"quantity": 1
}
],
"user": {
"id": "CUST_FITNESS_789123",
"email": ["[email protected]"],
"first_name": "Rachel",
"last_name": "Williams"
}
});
# Define the JSON body as a variable
BODY_JSON='{
"event": {
"name": "checkout_started",
"value": 1749.97,
"currency": "USD",
"id": "CHECKOUT_START_456789"
},
"context": {
"environment": "prod",
"data_source": "website"
},
"products": [
{
"id": "FITNESS_BIKE_001",
"sku": "FB-INDOOR-PRO-001",
"name": "Indoor Cycling Bike Pro",
"brand": "FitnessTech",
"price": 1199.99,
"quantity": 1
}
],
"user": {
"id": "CUST_FITNESS_789123",
"email": ["[email protected]"],
"first_name": "Rachel",
"last_name": "Williams"
}
}'
# Send the request using curl
curl -X POST "https://dre2.yourdomain.com/reshape/standard/event?id=YOUR_SCRIPT_ID" \
-H "Content-Type: application/json" \
-H "X-Dre-Access-Token: YOUR_ACCESS_TOKEN" \
-d "$BODY_JSON"
Product Properties Examples
Use the properties object to capture detailed product attributes that enable precise audience segmentation and better targeting in your advertising campaigns.
- Fashion Products
- Electronics
- Home & Garden
properties: {
color: ["black", "white"],
size: "M",
material: "cotton",
fit: "regular",
season: "summer",
collection: "2024_spring"
}
properties: {
color: "space_gray",
storage: "256GB",
connectivity: ["wifi", "bluetooth"],
warranty: "2_years",
energy_rating: "A++",
brand_series: "pro_line"
}
properties: {
color: ["natural", "oak"],
dimensions: "120x80x75cm",
material: ["wood", "metal"],
style: "modern",
room_type: ["living_room", "office"],
assembly_required: "true"
}
The value field should represent the total checkout value including all products, discounts, and checkout-level coupons to accurately track potential revenue at checkout initiation.
If user information is available at checkout initiation (e.g., logged-in users, returning users), it's highly recommended to include the user object alongside this event. This enables better user identification, personalization, and remarketing capabilities. Use the same user data structure as documented in the User Object section.
Implementation Best Practices
Event Timing
Checkout Button Click
// Trigger when checkout button is clicked
function proceedToCheckout() {
const cartData = getCurrentCartData();
// Track checkout started
reshape.push({
event: {
name: "checkout_started",
value: cartData.total,
currency: cartData.currency,
id: generateCheckoutId()
},
products: cartData.items,
coupons: cartData.appliedCoupons,
user: getCurrentUserData()
});
// Redirect to checkout
window.location.href = '/checkout';
}
Express Checkout Implementation
// For express checkout options
function startExpressCheckout(productId, quantity) {
const productData = getProductData(productId);
reshape.push({
event: {
name: "checkout_started",
value: productData.price * quantity,
currency: productData.currency,
id: generateCheckoutId()
},
products: [{
...productData,
quantity: quantity
}]
});
}
Data Collection Guidelines
Checkout Value Accuracy
- Include all applied discounts and coupon values
- Calculate total checkout value including taxes and fees
- Track both product-level and checkout-level coupons
Customer Data Integration
- Include user identification for logged-in customers
- Track guest vs member checkout selections
- Consider remarketing pixel triggers for abandoned checkouts
Funnel Optimization
- Monitor checkout initiation rates from cart views
- Track express checkout vs standard checkout usage
- Analyze high-value checkouts for VIP treatment