E-commerce Events
Vinoshipper will trigger a number of E-Commerce events with metadata when your customer shops on your website with Vinoshipper Injector installed or your Vinoshipper Shop page.
These events are based on Google's Recommended Events specifications and are used with Google Tag Manager and Google Analytics v4.
If you plan on using an unsupported analytics platform, you will need to setup Google Tag Manager and create the event associations using these events.
Data Associations
item_idThe Vinoshipper Product ID numberitem_nameThe product nameitem_skuThe product's SKU stringitem_categoryThe product category class
Events - Shopping
Sent when a customer adds an item to their shopping cart from a Vinoshipper Injector Add To Cart button or from the Vinoshipper Product Catalog.
Example:
{
items: [
{
item_id: "123",
item_name: "White Wine",
item_sku: "VS9876",
item_category: "WINE",
quantity: 1
}
]
}
Sent when a customer view the Vinoshipper Cart. This happens when the customer adds a product or when opening the cart window manually.
Example:
{
currency: "USD",
value: 120,
items: [
{
item_id: "123",
item_name: "White Wine",
item_sku: "VS9876",
item_category: "WINE",
discount: 0,
price: 60,
quantity: 2
},
{
item_id: "124",
item_name: "Red Wine",
item_sku: "VS432",
item_category: "WINE",
discount: 10,
price: 15,
quantity: 1
}
]
}
Sent when a customer removes an items from their shopping cart. Quantity sent is the number of items removed from the cart from either the Vinoshipper Injector Cart.
Example:
{
currency: "USD",
value: 120,
items: [
{
item_id: "123",
item_name: "White Wine",
item_sku: "VS9876",
item_category: "WINE",
discount: 0,
price: 60,
quantity: 2
}
]
}
Sent when a customer clicks "Checkout" form their Vinoshipper Injector Cart. This example shows two different products in the cart.
Example:
{
currency: "USD",
value: 120,
items: [
{
item_id: "123",
item_name: "White Wine",
item_sku: "VS9876",
item_category: "WINE",
discount: 0,
price: 60,
quantity: 2
},
{
item_id: "124",
item_name: "Red Wine",
item_sku: "VS432",
item_category: "WINE",
discount: 10,
price: 15,
quantity: 1
}
]
}
Sent when a customer completes their checkout and successfully makes a purchase as completed on Vinoshipper.com.
Example:
{
transaction_id: "831111111",
value: 107.47,
tax: 9.96,
shipping: 22.51,
currency: "USD",
items: [
{
index: 0,
item_id: "1234",
item_name: "White Wine",
item_sku: "VS9876",
item_category: "WINE",
discount: 9,
price: 60,
quantity: 2
},
{
index: 1,
item_id: "124",
item_name: "Red Wine",
item_sku: "VS432",
item_category: "WINE",
discount: 10,
price: 15,
quantity: 1
}
],
}
Under Development
The following events are in development. Once released, a properly configured GTM will also support these events.
view_itemview_item_listadd_payment_infoadd_shipment_info
Events - Club Registration
When using Club Registration, these events will fire allowing you to tract the customer journey when signing up for a Club. As these events do not fit the existing Google Analytics E-Commerce recommended events, all are custom.
Please read the Google Analytics Version 4 setup for instructions to make a successful club registration counted as a conversion.
club_registration_reset
When the user hits the “Clear” button, the form will completely reset.
club_registration_club_set
The user commits to a club selection (if more than one club can be selected) and if the registration is a gift (where applicable).
{
club_id: number,
club_name: string,
club_gift: true,
club_duration: number | null,
}
club_registration_gift_info [optional]
If the registration is a gift, this event will fire once the user as successfully submitted the gift recipient information. If the registration is not a gift, this event will never fire.
{
club_id: number,
club_name: string,
club_gift: boolean,
club_duration: number | null,
}
club_duration is the number of releases chosen by the buyer. If null, the buyer selected an ongoing club subscription.
We do not consider the gift recipient the user_id for purposes of analytics. The transaction is made by the individual paying for and sending the gift membership.
club_registration_delivery_complete
Finished the delivery or pick-up selection and resolved a delivery address.
{
club_id: number,
club_name: string,
club_gift: boolean,
club_delivery_option: 'PICKUP' | 'SHIPMENT',
}
Why not use add_shipping_info?
add_shipping_info?add_shipping_info is geared for a product checkout process, not meant for subscription without an intrinsic value. We also don’t set a shipping_tier during this process as that is determined when a club release is made.
club_registration_payment_failure
When the Customer has a payment method failure. This event is repeatable and could lead to the success step. If there are no failures, this event will not fire.
{
error_field: string | null,
error_code: string | null,
error_description: string | null,
error_description_short: string | null,
}
club_registration_payment_success
When the Customer has successfully attached a credit card to the registration.
If the user included a promo code, we include that as coupon.
{
coupon: string | null
}
Why not use add_payment_info?
add_payment_info?add_payment_info is geared for a product checkout process of specific items, not subscription based transactions.
club_registration_personal_info
When the user has completed the Personal Information step, this event will fire. This is not inclusive of Age Verification status.
This step will also include the email address as user_id value in Google Analytics v4 and Google Tag Manager.
{
club_member_email: string,
}
club_registration_av_attempt_fail
If the Age Verification has failed within the Club Registration form, this event is thrown for each attempt.
{
av_fail_count: number, // Number of failures.
}
club_registration_av_attempt_idology
This event is when a user is directed to Idology for Age Verification.
If the user fails the age verification check enough times, the user will be forwarded to vinoshipper.com and asked to perform additional steps with our age verification partner, Idology.
This step will also include the email address as user_id value in Google Analytics v4 and Google Tag Manager.
{
user_id: string,
club_id: number,
club_name: string,
club_gift: boolean,
transaction_id: string,
}
club_registration_complete_form
The user has resolved the age verification for registration. Immediately after this event, the user is directed to the post-signup confirmation URL, hosted on vinoshipper.com. This may include confirming email steps or further Age Verification steps.
This step will also establish the user_id value in Google Analytics v4 and Google Tag Manager.
{
club_id: number,
club_name: string,
club_member_email: string,
}
club_registration_to_verify
The user is directed to a page on vinoshipper.com and asked to wait for an email to verify that email address.
This step will also establish the user_id value in Google Analytics v4 and Google Tag Manager.
club_registration_complete
The user successfully completed Club Registration. The customer has verified their email address and is considered completely converted to the club.
This step will also establish the user_id value in Google Analytics v4 and Google Tag Manager. Please read the Google Analytics Version 4 setup for instructions to make a successful club registration counted as a conversion.
Updated 5 months ago