This reference describes canonical event schema version 1. Event names are append-only within the version. Each app receives only the events and top-level payload fields selected in its installed release.
Event |
Name |
Category |
Reliability |
Delivery |
Description |
|---|---|---|---|---|---|
|
Session started |
Browsing |
observation |
Browser, Server |
A new storefront browsing session began. |
|
Page viewed |
Browsing |
observation |
Browser, Server |
A storefront page was viewed. |
|
Product viewed |
Browsing |
observation |
Browser, Server |
A product detail page was viewed. |
|
Search performed |
Browsing |
observation |
Browser, Server |
A shopper submitted a storefront search. |
|
Cart item added |
Cart and wishlist |
durable |
Browser, Server |
A cart line was added or its quantity increased. |
|
Cart item updated |
Cart and wishlist |
durable |
Browser, Server |
A cart line quantity was changed. |
|
Cart item removed |
Cart and wishlist |
durable |
Browser, Server |
A cart line was removed or its quantity decreased. |
|
Wishlist item added |
Cart and wishlist |
durable |
Browser, Server |
A product or variant was added to a wishlist. |
|
Wishlist item removed |
Cart and wishlist |
durable |
Browser, Server |
A product or variant was removed from a wishlist. |
|
Checkout started |
Checkout and orders |
durable |
Browser, Server |
A checkout was created from a validated cart. |
|
Purchase completed |
Checkout and orders |
durable |
Browser, Server |
An order payment was authoritatively completed. |
|
Refund completed |
Checkout and orders |
durable |
Server |
A payment refund was authoritatively recorded. |
|
Order cancelled |
Checkout and orders |
durable |
Server |
An order cancellation was authoritatively recorded. Amounts and items are what the order still held when it was cancelled. |
|
Recommendations shown |
Browsing |
observation |
Browser, Server |
A recommendation placement displayed products. |
|
Recommendation clicked |
Browsing |
observation |
Browser, Server |
A shopper opened a product from a recommendation placement. |
|
Customer signed in |
Customer |
observation |
Browser, Server |
A customer successfully signed in without exposing their identifier. |
|
Customer registered |
Customer |
observation |
Browser, Server |
A customer account was successfully created without exposing its identifier. |
|
Order edited |
Checkout and orders |
durable |
Server |
A merchant changed the items of an order after its purchase was recorded. Amounts are the signed change the edit made. |
|
Newsletter sign-up |
Customer |
observation |
Browser, Server |
A shopper subscribed to the store's newsletter from the storefront. The email address is not included. |
|
Contact form sent |
Customer |
observation |
Browser, Server |
A shopper sent the storefront contact form. Nothing they typed is included. |
|
Payment chosen |
Checkout and orders |
observation |
Browser, Server |
A shopper chose how to pay and continued to payment, once per checkout cart. |
Session started (`session_started`)#
A new storefront browsing session began.
This event has an empty payload object.
{}
Page viewed (`page_view`)#
A storefront page was viewed.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Canonical storefront page type. |
|
string |
No |
Localized name shown for the viewed resource. |
|
string |
No |
Localized public handle for the resource. |
|
string |
No |
Stable identifier of the viewed resource. |
{
"display_name": "Canvas Print",
"page_type": "product",
"resource_id": "4821",
"slug": "canvas-print"
}
Product viewed (`product_viewed`)#
A product detail page was viewed.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
string |
Yes |
Localized public handle for the resource. |
|
string |
Yes |
Product or line title at event time. |
|
string |
No |
ISO 4217 currency code for the accompanying amounts. |
|
string |
No |
Exact major-unit decimal amount as a string. |
{
"currency": "INR",
"price": "1499.00",
"product_id": 4821,
"slug": "canvas-print",
"title": "Canvas Print",
"variant_id": 9102
}
Search performed (`search`)#
A shopper submitted a storefront search.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Shopper search query. |
|
integer |
No |
Number of matching results when known. |
{
"query": "canvas",
"results_total": 12
}
Cart item added (`cart_add`)#
A cart line was added or its quantity increased.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Canonical mutation action. |
|
string |
No |
Originating workflow when the mutation came from another feature. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
integer |
Yes |
Resulting line or item quantity. |
|
integer |
No |
Signed quantity change made by this mutation. |
|
string |
Yes |
Whether authoritative pricing was available for the mutation. |
|
string |
No |
Exact major-unit price for one unit as a string. |
|
string |
No |
Exact major-unit line total as a string. |
|
string |
Yes |
ISO 4217 currency code for the accompanying amounts. |
|
string |
Yes |
Exact major-unit cart or checkout subtotal as a string. |
|
integer |
Yes |
Total quantity across the cart or checkout. |
|
integer |
Yes |
Number of distinct cart lines. |
|
string |
No |
Product or line title at event time. |
|
string |
No |
SKU captured at event time when available. |
|
array of value |
No |
Applied coupon projections when available. |
|
boolean |
No |
True when the line carries a file an app attached, such as the shopper's uploaded design. |
{
"action": "added",
"currency": "INR",
"item_count": 2,
"line_total": "2998.00",
"pricing_status": "available",
"product_id": 4821,
"quantity": 2,
"quantity_delta": 1,
"sku": "CANVAS-A4",
"subtotal": "2998.00",
"title": "Canvas Print",
"unique_item_count": 1,
"unit_amount": "1499.00",
"variant_id": 9102
}
Cart item updated (`cart_update`)#
A cart line quantity was changed.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Canonical mutation action. |
|
string |
No |
Originating workflow when the mutation came from another feature. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
integer |
Yes |
Resulting line or item quantity. |
|
integer |
No |
Signed quantity change made by this mutation. |
|
string |
Yes |
Whether authoritative pricing was available for the mutation. |
|
string |
No |
Exact major-unit price for one unit as a string. |
|
string |
No |
Exact major-unit line total as a string. |
|
string |
Yes |
ISO 4217 currency code for the accompanying amounts. |
|
string |
Yes |
Exact major-unit cart or checkout subtotal as a string. |
|
integer |
Yes |
Total quantity across the cart or checkout. |
|
integer |
Yes |
Number of distinct cart lines. |
|
string |
No |
Product or line title at event time. |
|
string |
No |
SKU captured at event time when available. |
|
array of value |
No |
Applied coupon projections when available. |
|
boolean |
No |
True when the line carries a file an app attached, such as the shopper's uploaded design. |
{
"action": "updated",
"currency": "INR",
"item_count": 3,
"line_total": "4497.00",
"pricing_status": "available",
"product_id": 4821,
"quantity": 3,
"quantity_delta": 1,
"subtotal": "4497.00",
"unique_item_count": 1,
"unit_amount": "1499.00",
"variant_id": 9102
}
Cart item removed (`cart_remove`)#
A cart line was removed or its quantity decreased.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Canonical mutation action. |
|
string |
No |
Originating workflow when the mutation came from another feature. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
integer |
Yes |
Resulting line or item quantity. |
|
integer |
No |
Signed quantity change made by this mutation. |
|
string |
Yes |
Whether authoritative pricing was available for the mutation. |
|
string |
No |
Exact major-unit price for one unit as a string. |
|
string |
No |
Exact major-unit line total as a string. |
|
string |
Yes |
ISO 4217 currency code for the accompanying amounts. |
|
string |
Yes |
Exact major-unit cart or checkout subtotal as a string. |
|
integer |
Yes |
Total quantity across the cart or checkout. |
|
integer |
Yes |
Number of distinct cart lines. |
|
string |
No |
Product or line title at event time. |
|
string |
No |
SKU captured at event time when available. |
|
array of value |
No |
Applied coupon projections when available. |
|
boolean |
No |
True when the line carries a file an app attached, such as the shopper's uploaded design. |
{
"action": "removed",
"currency": "INR",
"item_count": 1,
"line_total": "1499.00",
"pricing_status": "available",
"product_id": 4821,
"quantity": 1,
"quantity_delta": -1,
"subtotal": "1499.00",
"unique_item_count": 1,
"unit_amount": "1499.00",
"variant_id": 9102
}
Wishlist item added (`wishlist_add`)#
A product or variant was added to a wishlist.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
string |
No |
Result of the wishlist operation. |
{
"effect": "added",
"product_id": 4821,
"variant_id": 9102
}
Wishlist item removed (`wishlist_remove`)#
A product or variant was removed from a wishlist.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
string |
No |
Result of the wishlist operation. |
{
"effect": "removed",
"product_id": 4821,
"variant_id": 9102
}
Checkout started (`begin_checkout`)#
A checkout was created from a validated cart.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Exact major-unit cart or checkout subtotal as a string. |
|
string |
No |
Exact major-unit event value after applicable discounts. |
|
string |
Yes |
ISO 4217 currency code for the accompanying amounts. |
|
integer |
Yes |
Total quantity across the cart or checkout. |
|
array of object |
No |
Line-item snapshot included with the event. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
string |
No |
SKU captured at event time when available. |
|
string |
No |
Product or line title at event time. |
|
integer |
Yes |
Resulting line or item quantity. |
|
string |
Yes |
Exact major-unit price for one unit as a string. |
|
string |
Yes |
Exact major-unit line total as a string. |
|
string |
No |
Unit amount converted into the store reporting currency. |
|
string |
No |
Line total converted into the store reporting currency. |
|
string |
No |
Unit price without tax and before order discounts, in the order currency. |
|
string |
No |
Order discount on the items without tax, in the order currency; shipping discounts excluded. |
{
"currency": "INR",
"item_count": 2,
"items": [
{
"line_total": "2998.00",
"product_id": 4821,
"quantity": 2,
"sku": "CANVAS-A4",
"title": "Canvas Print",
"unit_amount": "1499.00",
"variant_id": 9102
}
],
"subtotal": "2998.00",
"value": "2798.00"
}
Purchase completed (`purchase`)#
An order payment was authoritatively completed.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Stable Tringify order identifier. |
|
string |
No |
Merchant-facing order number when available. |
|
string |
Yes |
ISO 4217 currency code for the accompanying amounts. |
|
string |
Yes |
Exact major-unit event value after applicable discounts. |
|
string |
No |
Store reporting currency used for normalized reporting. |
|
string |
No |
Exact value converted into the store reporting currency. |
|
array of object |
No |
Line-item snapshot included with the event. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
string |
No |
SKU captured at event time when available. |
|
string |
No |
Product or line title at event time. |
|
integer |
Yes |
Resulting line or item quantity. |
|
string |
Yes |
Exact major-unit price for one unit as a string. |
|
string |
Yes |
Exact major-unit line total as a string. |
|
string |
No |
Unit amount converted into the store reporting currency. |
|
string |
No |
Line total converted into the store reporting currency. |
|
string |
No |
Unit price without tax and before order discounts, in the order currency. |
|
string |
No |
Order discount on the items without tax, in the order currency; shipping discounts excluded. |
|
string |
No |
Exact total discount amount in the order currency. |
|
string |
No |
Exact shipping amount in the order currency. |
|
string |
No |
Exact tax amount in the order currency. |
|
boolean |
No |
Whether the order retained an eligible attribution touch. |
|
boolean |
No |
Whether the order's item prices include tax. |
|
string |
No |
Market the order was placed in. |
|
string |
No |
ISO 3166-1 alpha-2 country of the shipping address, or of the billing address when nothing ships. |
|
string |
No |
Language the order was placed in, such as fr or en-GB. Absent on orders placed before it was recorded. |
|
string |
No |
Order discount on the items without tax, in the order currency; shipping discounts excluded. |
{
"base_currency": "INR",
"base_value": "2798.00",
"currency": "INR",
"discount_ex_tax": "169.49",
"discount_total": "200.00",
"has_attribution": true,
"items": [
{
"base_line_total": "2998.00",
"base_unit_amount": "1499.00",
"discount_ex_tax": "169.49",
"line_total": "2998.00",
"product_id": 4821,
"quantity": 2,
"unit_amount": "1499.00",
"unit_amount_ex_tax": "1270.34",
"variant_id": 9102
}
],
"locale": "en",
"market_id": "9a1f2c3d-4e5f-6789-abcd-ef0123456789",
"order_id": "66b0a1d2-4f13-4d32-a51d-93e595034e95",
"order_number": "1042",
"shipping": "0.00",
"shipping_country": "IN",
"tax": "426.81",
"tax_included": true,
"value": "2798.00"
}
Refund completed (`refund`)#
A payment refund was authoritatively recorded.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Stable Tringify order identifier. |
|
string |
No |
Stable refund transaction identifier. |
|
string |
Yes |
ISO 4217 currency code for the accompanying amounts. |
|
string |
Yes |
Exact major-unit event value after applicable discounts. |
|
string |
No |
Store reporting currency used for normalized reporting. |
|
string |
No |
Exact value converted into the store reporting currency. |
|
array of object |
No |
Line-item snapshot included with the event. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
string |
No |
SKU captured at event time when available. |
|
string |
No |
Product or line title at event time. |
|
integer |
Yes |
Resulting line or item quantity. |
|
string |
Yes |
Exact major-unit price for one unit as a string. |
|
string |
Yes |
Exact major-unit line total as a string. |
|
string |
No |
Unit amount converted into the store reporting currency. |
|
string |
No |
Line total converted into the store reporting currency. |
|
string |
No |
Unit price without tax and before order discounts, in the order currency. |
|
string |
No |
Order discount on the items without tax, in the order currency; shipping discounts excluded. |
{
"base_currency": "INR",
"base_value": "1499.00",
"currency": "INR",
"items": [
{
"base_line_total": "1499.00",
"base_unit_amount": "1499.00",
"line_total": "1499.00",
"product_id": 4821,
"quantity": 1,
"unit_amount": "1499.00"
}
],
"order_id": "66b0a1d2-4f13-4d32-a51d-93e595034e95",
"refund_transaction_id": "refund_1042_1",
"value": "1499.00"
}
Order cancelled (`cancellation`)#
An order cancellation was authoritatively recorded. Amounts and items are what the order still held when it was cancelled.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Stable Tringify order identifier. |
|
string |
Yes |
ISO 4217 currency code for the accompanying amounts. |
|
string |
Yes |
Exact major-unit event value after applicable discounts. |
|
string |
No |
Store reporting currency used for normalized reporting. |
|
string |
No |
Exact value converted into the store reporting currency. |
|
array of object |
No |
Line-item snapshot included with the event. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
string |
No |
SKU captured at event time when available. |
|
string |
No |
Product or line title at event time. |
|
integer |
Yes |
Resulting line or item quantity. |
|
string |
Yes |
Exact major-unit price for one unit as a string. |
|
string |
Yes |
Exact major-unit line total as a string. |
|
string |
No |
Unit amount converted into the store reporting currency. |
|
string |
No |
Line total converted into the store reporting currency. |
|
string |
No |
Unit price without tax and before order discounts, in the order currency. |
|
string |
No |
Order discount on the items without tax, in the order currency; shipping discounts excluded. |
{
"base_currency": "INR",
"base_value": "2798.00",
"currency": "INR",
"items": [
{
"base_line_total": "2998.00",
"base_unit_amount": "1499.00",
"line_total": "2998.00",
"product_id": 4821,
"quantity": 2,
"unit_amount": "1499.00",
"variant_id": 9102
}
],
"order_id": "66b0a1d2-4f13-4d32-a51d-93e595034e95",
"value": "2798.00"
}
Recommendations shown (`rec_impression`)#
A recommendation placement displayed products.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Stable recommendation placement identifier. |
|
array of integer |
Yes |
Stable product identifiers shown in the placement. |
|
string |
No |
Recommendation strategy identifier when available. |
{
"placement": "related-products",
"product_ids": [
4821,
4822
],
"strategy": "related"
}
Recommendation clicked (`rec_click`)#
A shopper opened a product from a recommendation placement.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Stable recommendation placement identifier. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
{
"placement": "related-products",
"product_id": 4821,
"variant_id": 9102
}
Customer signed in (`customer_login`)#
A customer successfully signed in without exposing their identifier.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Authentication method used: email or phone. |
|
string |
Yes |
Storefront surface where the action completed: for sign-in, account or checkout; for forms, website (newsletter) or contact_page. |
{
"provider": "email",
"surface": "account"
}
Customer registered (`customer_register`)#
A customer account was successfully created without exposing its identifier.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Authentication method used: email or phone. |
|
string |
Yes |
Storefront surface where the action completed: for sign-in, account or checkout; for forms, website (newsletter) or contact_page. |
{
"provider": "email",
"surface": "checkout"
}
Order edited (`order_edited`)#
A merchant changed the items of an order after its purchase was recorded. Amounts are the signed change the edit made.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Stable Tringify order identifier. |
|
string |
Yes |
Stable order edit identifier. |
|
integer |
Yes |
Order version the edit produced. |
|
string |
Yes |
ISO 4217 currency code for the accompanying amounts. |
|
string |
Yes |
Signed change in the order total made by the edit, in the order currency. |
|
string |
Yes |
Store reporting currency used for normalized reporting. |
|
string |
Yes |
Signed change in the order total converted into the store reporting currency. |
|
array of object |
No |
Line-item snapshot included with the event. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
string |
No |
SKU captured at event time when available. |
|
string |
No |
Product or line title at event time. |
|
integer |
Yes |
Signed quantity change made by this mutation. |
|
string |
Yes |
Signed change in the line total, in the order currency. |
|
string |
Yes |
Signed change in the line total converted into the store reporting currency. |
{
"base_currency": "INR",
"base_value_change": "-1499.00",
"currency": "INR",
"edit_id": "0f3c2a8e-5b1d-4e6f-9a7c-2d4b8e1f6a3c",
"items": [
{
"base_line_total_delta": "-1499.00",
"line_total_delta": "-1499.00",
"product_id": 4821,
"quantity_delta": -1,
"variant_id": 9102
}
],
"order_id": "66b0a1d2-4f13-4d32-a51d-93e595034e95",
"order_version": 2,
"value_change": "-1499.00"
}
Newsletter sign-up (`newsletter_signup`)#
A shopper subscribed to the store's newsletter from the storefront. The email address is not included.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Storefront surface where the action completed: for sign-in, account or checkout; for forms, website (newsletter) or contact_page. |
{
"surface": "website"
}
Contact form sent (`contact_submitted`)#
A shopper sent the storefront contact form. Nothing they typed is included.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Storefront surface where the action completed: for sign-in, account or checkout; for forms, website (newsletter) or contact_page. |
{
"surface": "contact_page"
}
Payment chosen (`payment_info_added`)#
A shopper chose how to pay and continued to payment, once per checkout cart.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
Exact major-unit cart or checkout subtotal as a string. |
|
string |
No |
Exact major-unit event value after applicable discounts. |
|
string |
Yes |
ISO 4217 currency code for the accompanying amounts. |
|
integer |
Yes |
Total quantity across the cart or checkout. |
|
array of object |
No |
Line-item snapshot included with the event. |
|
integer |
Yes |
Stable product identifier. |
|
integer |
No |
Stable selected variant identifier when one applies. |
|
string |
No |
SKU captured at event time when available. |
|
string |
No |
Product or line title at event time. |
|
integer |
Yes |
Resulting line or item quantity. |
|
string |
Yes |
Exact major-unit price for one unit as a string. |
|
string |
Yes |
Exact major-unit line total as a string. |
|
string |
No |
Unit amount converted into the store reporting currency. |
|
string |
No |
Line total converted into the store reporting currency. |
|
string |
No |
Unit price without tax and before order discounts, in the order currency. |
|
string |
No |
Order discount on the items without tax, in the order currency; shipping discounts excluded. |
|
string |
Yes |
How the shopper chose to pay: online, cod or store_credit. |
{
"currency": "INR",
"item_count": 2,
"items": [
{
"line_total": "2998.00",
"product_id": 4821,
"quantity": 2,
"sku": "CANVAS-A4",
"title": "Canvas Print",
"unit_amount": "1499.00",
"variant_id": 9102
}
],
"payment_method": "online",
"subtotal": "2998.00",
"value": "2798.00"
}