Shipping Details Added
Definition
shipping_details_added event is recorded when a visitor provides shipping information during the checkout process on an e-commerce website.Usage
shipping_details_added event is triggered.Common schema
detail object containing information about the checkout products(s).The
detail object must include the following properties:detail.valuerequiredThe 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.productsrequiredAn array containing details of the products in the checkout process. Each product detail is an object with a standard structure.Expand
Product ID Product SKU Product name 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). Product variants Variant ID Variant SKU Variant Global Trade Item Number Variant Manufacturer Part Number Variant European Article Number The name of the variant. Base/original price of product variant Current price of product variant Prices include tax Tax percent Variant quantity. Additional properties that provide more details about the product or its options, such as size, color, material, or configuration. Stock status of variant Stock location of variant Product variant added timestamp in milliseconds Product Brand/Manufacturer 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 Product url Product main image url 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
Expand product object common schema
product
Product or service details
id
string
required
sku
string
optional
name
string
required
type
enum<string>
required
Allowed values:
simplevariablevirtualbundlesubscriptionexternal
Default:
simple
variants
array[object (variant) {17}]
required
>= 1 items<= 20 items
id
string
required
sku
string
optional
gtin
string
optional
mpn
string
optional
ean
string
optional
name
string
required
Match pattern:
^[\w\d\s\-]+$
price_base
number
required
>= 0
Multiple of:
0.01
price
number
required
>= 0
Multiple of:
0.01
tax_included
boolean
required
Default:
true
tax_percent
integer
required
>= 0<= 100
Multiple of:
1
quantity
integer
required
>= 1
Default:
1
Example:
1
Multiple of:
1
properties
array[object (property) {2}] | null
optional
stock_status
string
optional
>= 1 characters
Examples:
truefalsein stockout of stock
Match pattern:
^[\w\d\s\-]+$
stock_location
string
optional
added_at
integer
optional
Example:
1748505040077
url
string <uri>
optional
Example:
https://www.example.com/product-variant-page
images
array[string <uri>]
required
brand
string
required
categories
array [object {2}]
optional
name
string
required
Examples:
FIRST_CATEGORYSECOND_CATEGORY
id
optional
url
string <uri>
optional
Example:
https://www.example.com/product-page
image
string <uri>
optional
Example:
"http://example.com/images/product-main-image.jpg",
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
detail.shippingrequiredThe shipping detailsExpand
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.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-05-29 10:45:11