Customer events reference
Customer events represent and describe the behaviour of your customers, including key events during their customer journey, such as page views, product views, cart updates, searches, and purchases.
Standard events
Anchor link to section titled "Standard events"Shopify currently publishes a limited set of standard events. Standard events are ones we make available out-of-the-box and we offer a few guarantees about their content and availability. Growing this list with Partners will help ensure we have broad coverage. Standard events are available on various surfaces, such as Storefront, Checkout and Order Status.
page_viewed
Anchor link to section titled "page_viewed"This event logs an instance where a visitor visited a page. This event is available on the Storefront, Checkout, and Order Status surfaces.
| Name | Type | Example value | Description |
|---|---|---|---|
| event_id | String | event_123 |
The ID of the page viewed event |
| page_url | String | http://store.myshopify.com/page |
The URL of the page that was viewed |
| page_title | String | Page 1 |
The title of the page that was viewed |
| page_referrer | String | http://store.myshopify.com/pageref |
The page that referred the user to the current page view |
product_viewed
Anchor link to section titled "product_viewed"This event logs an instance where a visitor browsed to a product details page. This event is available on the Storefront surface.
| Name | Type | Example value | Description |
|---|---|---|---|
| event_id | String | event_123 |
The ID of the product viewed event |
| products | Product[] | [Item 1, Item 2] |
A list of the products viewed |
product_added_to_cart
Anchor link to section titled "product_added_to_cart"This event logs an instance where a visitor adds a product to their cart. This event is available on the Storefront surface.
| Name | Type | Example value | Description |
|---|---|---|---|
| event_id | String | event_123 |
The ID of the product added to cart event |
| products | Product[] | [Item 1, Item 2] |
A list of the products added to cart |
collection_viewed
Anchor link to section titled "collection_viewed"This event logs an instance where a visitor browsed to a product collection index page. This event is available on the Storefront surface.
| Name | Type | Example value | Description |
|---|---|---|---|
| event_id | String | event_123 |
The ID of the collection viewed event |
| collection_title | String | Collection 1 |
The name of the collection that was viewed |
search_submitted
Anchor link to section titled "search_submitted"This event logs an instance where a visitor performed a search on the storefront. This event is available on the Storefront surface.
| Name | Type | Example value | Description |
|---|---|---|---|
| event_id | String | event_123 |
The ID of the search submitted event |
| search_query | String | search item |
The search query that was run |
checkout_started
Anchor link to section titled "checkout_started"This event logs an instance of a visitor starting the checkout process. This event is available on the Checkout surface.
| Name | Type | Example value | Description |
|---|---|---|---|
| event_id | String | event_123 |
The ID of the checkout started event |
| products | Product[] | [item 1, item 2] |
The products that were part of the checkout |
| total_price | float | 132.41 |
The total price of the products being checked out |
| currency | String | USD |
The currency being used for the checkout |
payment_info_submitted
Anchor link to section titled "payment_info_submitted"This event logs an instance of a visitor submitting their payment information. This event is available on the Checkout surface.
| Name | Type | Example value | Description |
|---|---|---|---|
| event_id | String | event_123 |
The ID of the payment info submitted event |
| currency | String | USD |
The currency being used for the payment |
| total_price | float | 132.41 |
The total price of the payment |
checkout_completed
Anchor link to section titled "checkout_completed"This event logs when a visitor completes a purchase. This event is available on the Order Status and Checkout surface.
| Name | Type | Example value | Description |
|---|---|---|---|
| event_id | String | event_123 |
The ID of the checkout completed event |
| email_sha256 | String | 73062D872926C2A556F17B36F50E328DDF |
A SHA256 hash of the email used for checkout |
| phone_sha256 | String | 29EC0A06044BEDFF0BEC4D81516DA5843C |
A SHA256 hash of the phone number used for checkout |
| products | Product[] | [item 1, item 2] |
A list of products purchased in the checkout |
| checkout_id | Integer | 12345 |
The ID associated with the checkout |
| order_id | Integer | 12346 |
The ID associated with the order for the purchase |
| total_price | float | 135.43 |
The total price of the purchase |
| subtotal_price | float | 120.25 |
The subtotal of the purchase |
| shipping_price | float | 14.95 |
The total cost of shipping for the purchase |
| tax_price | float | 15.95 |
The total cost of tax for the purchase |
| discount_code | String | SHOPIFYDISCOUNT |
The discount code used for the purchase |
| currency | String | USD |
The currency used for the purchase |
Standard objects
Anchor link to section titled "Standard objects"Some events reference types of objects, which have their own schema.
Product is used to store details about various products on a Shopify store.
| Name | Type | Example value | Description |
|---|---|---|---|
| product_id | integer | 123 |
The ID of the product |
| product_gid | String | abc123 |
The Shopify GID for the product |
| product_title | String | Page 1 |
The title of the product that was viewed |
| variant_price | Number | 22.50 |
The price of the product |
| product_vendor | String | vendor |
The vendor of the product |
| variant_id | integer | 123 |
The ID of the product variant |
| variant_title | String | variant |
The title of the variant |
| variant_sku | String | abc123 |
The SKU of the variant |
| collection_title | String | collection |
The name of the collection |
| quantity | integer | 12 |
The stock quantity of the item |
| currency | String | USD |
The currency used for the price |