Checkout Completed
Definition
checkout_completed event is recorded when a visitor completes a purchase on an e-commerce website, indicating a successful transaction.Usage
checkout_completed event is triggered.Common schema
detail object containing information about the checkout products(s).The
detail object must include the following properties:detail.event_valuerequiredThe total value of the event usually represents the order value. (Use dot as decimal separator).
detail.productsrequiredAn array containing details of the products in the checkout process. Each product detail is an object with a standard structure.Expand
The identifiers of the product/service. The ID of the product/service. Usualy is the variant ID. The parent ID of the product. Usualy is the main product ID. The SKU of the product/service. The parent SKU of the product. Usualy is the main product SKU. The name of the product/service. The monetary base price of the product, in units of the specified currency parameter. The monetary current price of the product, in units of the specified currency parameter. Tax percent applied to the item If the base price and current price include taxes Currency of the items associated with the event, in 3-letter ISO 4217 format. Product quantity. Specifies the product type. This helps differentiate how the product behaves in the e-commerce system (e.g., whether it can be delivered, has variants, or is a bundle of items). Additional properties that provide more details about the product or its options, such as size, color, material, or configuration. Name of property Value of property The brand of the product/service. Brand Name Brand ID An ordered array of categories representing the taxonomy or hierarchy the product belongs to. The first item must be the top-level category, followed by subcategories in order. Category Name Category ID Coupon objects scoped to a specific product, applied exclusively to that product. Coupon name Coupon value Currency in 3-letter ISO 4217 format. Tax percent applied to the coupon value If the coupon value includes taxes Coupon ID Stock status of item
Expand product object common schema
product
Product or service details
id
object (id)
required
product_id
string
required
Examples:
123456abcdef
Match pattern:
^[a-zA-Z0-9_-]{3,}$
parent_id
string
optional
Example:
parent-1234
Match pattern:
^[a-zA-Z0-9_-]{3,}$
product_sku
string
optional
Example:
abc
Match pattern:
^[a-zA-Z0-9_-]{3,}$
parent_sku
string
optional
Example:
parent-abc
Match pattern:
^[a-zA-Z0-9_-]{3,}$
name
string
required
Match pattern:
^[\w\d\s\-]+$
price
object (price)
required
base
number
required
> 0
Example:
1001.99
Multiple of:
0.01
current
number
required
>= 0
Example:
1001.99
Multiple of:
0.01
tax_percent
integer
required
>= 0<= 99
Examples:
199
Multiple of:
1
tax_included
boolean
required
currency
string
required
Examples:
EURUSDRON
Match pattern:
^[A-Z]{3}$
quantity
integer
required
>= 1
Default:
1
Example:
1
Multiple of:
1
type
enum<string>
required
Allowed values:
simplevariablevirtualbundlesubscriptionexternal
Default:
simple
properties
array[object (property) {2}] | null
optional
name
string
required
value
string
required
brands
array[object (brand) {2}] | null
optional
name
string
required
Example:
BRAND_NAME
id
optional
categories
array[object (category) {2}]
optional
name
string
required
Examples:
FIRST_CATEGORYSECOND_CATEGORY
id
optional
coupons
array[object (coupon) {7}]
optional
name
string
required
Example:
PRODUCT_COUPON_NAME
value
number
required
>= 0
Example:
10.99
Multiple of:
0.01
currency
string
required
Example:
EUR
Match pattern:
^[A-Z]{3}$
tax_percent
string
required
tax_included
boolean
required
id
optional
type
string
required
stock_status
string
optional
>= 1 characters
Examples:
truefalsein stockout of stock
Match pattern:
^[\w\d\s\-]+$
detail.shippingrequiredThe shipping details (e.g. Ground, Air, Next-day) selected for delivery of the purchased item.Expand
Delivery or shipping name Delivery/shipping cost Currency in 3-letter ISO 4217 format. Tax percent applied to this delivery/shipping value If the delivery/shipping value includes taxes Delivery or shipping internal ID The delivery method type. Examples include standard, express, store_pickup, or digital.
Expand shipping object common schema
delivery
name
string
required
Example:
PRODUCT_COUPON_NAME
value
number
required
>= 0
Example:
10.99
Multiple of:
0.01
currency
string
required
Example:
EUR
Match pattern:
^[A-Z]{3}$
tax_percent
string
required
tax_included
boolean
required
id
optional
Any of
> 0
Multiple of:
1
type
string
required
Examples:
standardexpressdigital
detail.paymentsrequiredThe payment details selected.Expand
Payment name Total amount paid using this payment method Currency in 3-letter ISO 4217 format. Payment ID Type of payment
Expand payment object common schema
payment
name
string
required
Example:
PRODUCT_COUPON_NAME
value
number
required
>= 0
Example:
10.99
Multiple of:
0.01
currency
string
required
Example:
EUR
Match pattern:
^[A-Z]{3}$
id
optional
Any of
type
string
required
detail.couponsoptionalAn array containing details of the coupons associated with the event.Expand
Coupon name Coupon value Currency in 3-letter ISO 4217 format. Tax percent applied to the coupon value If the coupon value includes taxes Coupon ID
Expand coupon object common schema
coupon
name
string
required
Example:
PRODUCT_COUPON_NAME
value
number
required
>= 0
Example:
10.99
Multiple of:
0.01
currency
string
required
Example:
EUR
Match pattern:
^[A-Z]{3}$
tax_percent
string
required
tax_included
boolean
required
id
optional
Any of
type
string
required
Example
Modified at 2025-04-29 12:33:17