Skip to content

Shopify data features

This article provides an overview of our Shopify features, including what Shopify data is tracked and example payloads, historical backfill, and product syncs.

Tracked Shopify events

The Shopify integration uses eCommerce recommended events to capture key shopping behaviors. For implementation examples and marketing strategies using these events, refer to eCommerce use cases.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

{
    "name": "ecommerce.product_viewed",
    "properties": {
        "product_id": "12345",
        "product_name": "product",
        "variant_id": "123",
        "image_url": "www.image-url.com",
        "product_url": "mystorefront.myshopify.com/product",
        "price": 10,
        "currency": "USD",
        "source": "mystorefront.myshopify.com",
        "metadata": {
          "sku": "sku"
        },
        "type": [
          "price_drop",
          "back_in_stock"
        ]
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

{
    "name": "ecommerce.cart_updated",
    "properties": {
        "cart_id": "Z2NwLXVzLWVhc3QxOjAxSjk3UFg4RlFZMjVTVkRHRlc1RlI3SlRY",
        "currency": "USD",
        "total_value": 2000000,
        "products": [
            {
                "product_id": "8266836345064",
                "product_name": "PANTS!!!",
                "variant_id": "44610569208040",
                "image_url": "https://cdn.shopify.com/s/files/1/0604/4211/6328/files/1200px-Trousers-colourisolated.jpg?v=1689256168",
                "product_url": "https://test-store.myshopify.com/products/pants?variant=44610569208040",
                "quantity": 2,
                "price": 1000000,
                "metadata": {
                    "sku": "007"
                }
            }
        ],
        "source": "https://test-store.myshopify.com",
        "metadata": {}
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

{
    "name": "ecommerce.checkout_started",
    "time": "2022-05-23T13:52:38-04:00",
    "properties": {
        "cart_id": "eeafa272cebfd4b22385bc4b645e762c",
        "total_value": 421.88,
        "subtotal_value": 396.88,
        "tax": 15.00,
        "shipping": 10.00,
        "currency": "USD",
        "products": [
            {
                "product_id": "632910392",
                "product_name": "IPod Nano - 8GB",
                "variant_id": "808950810",
                "quantity": 1,
                "price": 199,
                "metadata": {
                    "sku": "IPOD2008PINK"
                }
            }
        ],
        "source": "braze-mock-storefront.myshopify.com",
        "checkout_id": "123123123",
        "metadata": {
            "checkout_url": "https://checkout.local/548380009/checkouts/123123123/recover?key=example-secret-token"
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

{
    "name": "ecommerce.order_placed",
    "time": "2022-05-23T13:52:38-04:00",
    "properties": {
        "order_id": "820982911946154508",
        "cart_id": "eeafa272cebfd4b22385bc4b645e762c",
        "total_value": 421.88,
        "subtotal_value": 396.88,
        "tax": 15.00,
        "shipping": 10.00,
        "currency": "USD",
        "total_discounts": 5,
        "discounts": [],
        "products": [
            {
                "product_id": "632910392",
                "product_name": "IPod Nano - 8GB",
                "variant_id": "808950810",
                "quantity": 1,
                "price": 199,
                "metadata": {
                    "sku": "IPOD2008PINK"
                }
            }
        ],
        "source": "braze-mock-storefront.myshopify.com",
        "metadata": {
            "order_status_url": "https://apple.myshopify.com/690933842/orders/123456abcd/authenticate?key=abcdefg",
            "order_number": "1234",
            "tags": [
                "heavy",
                "heavy2"
            ],
            "referring_site": "https://www.google.com",
            "payment_gateway_names": [
                "visa",
                "bogus"
            ]
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

{
 "name": "shopify_fulfilled_order",
 "time": "2022-05-23T14:44:34-04:00",
 "properties": {
   "order_id": 4444668657855,
   "line_items": [
     {
       "quantity": 1,
       "product_id": 6143032066239,
       "sku": null,
       "title": "Dark Denim Top",
  "variant_id": 40094740549876,
       "variant_title": "Small Dark Denim Top",


       "vendor": "partners-demo",
       "name": "Dark Denim Top",
       "properties": [],
       "price": "60.00",
       "fulfillment_status": "fulfilled"
     }
   ],
   "shipping": [
     {
       "title": "Standard",
       "price": "0.00"
     }
   ],
   "total_price": "130.66",
   "confirmed": true,
   "total_discounts": "0.00",
   "discount_codes": [],
   "order_number": 1093,
   "order_status_url": "https://test-store.myshopify.com/",
   "cancelled_at": null,
   "tags": "",
   "closed_at": "2022-05-23T14:44:34-04:00",
   "fulfillment_status": "fulfilled",
   "fulfillments": [
     {
       "shipment_status": null,
       "status": "success",
       "tracking_company": "Other",
       "tracking_number": "456",
       "tracking_numbers": [
         "456"
       ],
       "tracking_url": "https://braze.com",
       "tracking_urls": [
         "https://braze.com"
       ],
       "line_items": [
         {
           "fulfillment_status": "fulfilled",
           "name": "Dark Denim Top",
           "price": "60.00",
           "product_id": 6143032066239,
           "quantity": 1,
           "requires_shipping": true,
           "sku": null,
           "title": "Dark Denim Top",
           "variant_id": 40094740549876,
           "variant_title": "Small Dark Denim Top",
           "vendor": "partners-demo"
         }
       ]
     }
   ]
 },
 "braze_id": "123abc123abc"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

{
 "name": "shopify_partially_fulfilled_order",
 "time": "2022-05-23T14:43:34-04:00",
 "properties": {
   "order_id": 4444668657855,
   "line_items": [
     {
       "quantity": 1,
       "product_id": 6143032066239,
       "sku": null,
       "title": "Dark Denim Top",
       "variant_id": 40094740549876,
       "variant_title": "",
       "vendor": "partners-demo",
       "name": "Dark Denim Top",
       "properties": [],
       "price": "60.00",
       "fulfillment_status": "fulfilled"
     }
   ],
   "shipping": [
     {
       "title": "Standard",
       "price": "0.00"
     }
   ],
   "total_price": "130.66",
   "confirmed": true,
   "total_discounts": "0.00",
   "discount_codes": [],
   "order_number": 1093,
   "order_status_url": "https://test-store.myshopify.com/",
   "cancelled_at": null,
   "tags": "",
   "closed_at": null,
   "fulfillment_status": "partial",
   "fulfillments": [
     {
       "shipment_status": null,
       "status": "success",
       "tracking_company": "Other",
       "tracking_number": "123",
       "tracking_numbers": [
         "123"
       ],
       "tracking_url": "https://braze.com",
       "tracking_urls": [
         "https://braze.com"
       ],
       "line_items": [
         {
           "fulfillment_status": "fulfilled",
           "name": "Dark Denim Top",
           "price": "60.00",
           "product_id": 6143032066239,
           "properties": [],
           "quantity": 1,
           "requires_shipping": true,
           "sku": null,
           "title": "Dark Denim Top",
           "variant_id": 40094740549876,
           "variant_title": "",
           "vendor": "partners-demo"
         }
       ]
     }
   ]
 },
 "braze_id": "abc123abc123"
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

{
 "name": "shopify_paid_order",
 "time": "2022-05-23T13:52:38-04:00",
 "properties": {
   "order_id": 4444596371647,
   "line_items": [
     {
       "quantity": 1,
       "product_id": 6143033344191,
       "sku": null,
       "title": "LED High Tops",
       "variant_id": 40094740549876,
       "variant_title": null,
       "vendor": "partners-demo",
       "name": "LED High Tops",
       "properties": [],
       "price": "80.00",
       "fulfillment_status": null
     }
   ]
 }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

{
    "name": "ecommerce.order_cancelled",
    "time": "2022-05-23T13:52:38-04:00",
    "properties": {
        "order_id": "820982911946154508",
        "cancel_reason": "no longer necessary",
        "total_value": 421.88,
        "subtotal_value": 396.88,
        "tax": 15.00,
        "shipping": 10.00,
        "currency": "USD",
        "total_discounts": 5,
        "discounts": [],
        "products": [
            {
                "product_id": "632910392",
                "product_name": "IPod Nano - 8GB",
                "variant_id": "808950810",
                "quantity": 1,
                "price": 199,
                "metadata": {
                    "sku": "IPOD2008PINK"
                }
            }
        ],
        "source": "braze-mock-storefront.myshopify.com",
        "metadata": {
            "order_status_url": "https://apple.myshopify.com/690933842/orders/123456abcd/authenticate?key=abcdefg",
            "order_number": "1234",
            "tags": [
                "heavy",
                "heavy2"
            ]
        }
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

{
    "name": "ecommerce.order_refunded",
    "time": "2022-05-23T13:52:38-04:00",
    "properties": {
        "order_id": "820982911946154508",
        "total_value": 421.88,
        "currency": "USD",
        "products": [
            {
                "product_id": "632910392",
                "product_name": "IPod Nano - 8GB",
                "variant_id": "808950810",
                "quantity": 1,
                "price": 199,
                "metadata": {
                    "sku": "IPOD2008PINK"
                }
            }
        ],
        "source": "braze-mock-storefront.myshopify.com",
        "metadata": {
		"order_note": "item was broken"
        }
    }
} 

1
2
3
4
5
6

{
	"name": "shopify_account_login",
	"properties": {
	"source": "braze-mock-storefront.myshopify.com"
  }
}

Event: ecommerce.product_viewed
Type: Recommended event
Triggered: When a customer views a product page
Data source: Braze SDKs
Use Case: Browse abandonment

Variable Liquid templating
product_id {{event_properties.${product_id}}}
product_name {{event_properties.${product_name}}}
variant_id {{event_properties.${variant_id}}}
image_url {{event_properties.${image_url}}}
product_url <your-store.myshopify.com>{{event_properties.${product_url}}}

Add your Shopify site domain before the URL.
price {{event_properties.${price}}}
currency {{event_properties.${currency}}}
source {{event_properties.${source}}}
sku {{event_properties.${metadata}[0].sku}}
type event_properties.${type}

Event: ecommerce.cart_updated
Type: Recommended event
Triggered: When a customer adds, removes, or updates their shopping cart
Data source: Braze SDKs
Use Case: Cart abandonment

For Abandoned Cart Canvases, you first need to add the initial shopping cart Liquid tag to gain context of the shopping cart in your message.

1

{% shopping_cart {{context.${cart_id}}} %}

Then you can add the following shopping cart Liquid tags into your message.

Variable Liquid templating
cart_id {{ shopping_cart.cart_id }}
currency {{ shopping_cart.currency }}
total_value {{ shopping_cart.total_value }}
product_id {{ shopping_cart.products[0].product_id }}
product_name {{ shopping_cart.products[0].product_name }}
variant_id {{ shopping_cart.products[0].variant_id }}
image_url {{ shopping_cart.products[0].image_url }}
product_url {{ shopping_cart.products[0].product_url }}
quantity {{ shopping_cart.products[0].quantity }}
price {{ shopping_cart.products[0].price }}
sku {{ shopping_cart.products[0].metadata[0].sku }}
source {{ shopping_cart.source }}
metadata (value) {{ shopping_cart.metadata[0].<add_value_here> }}

Event: ecommerce.checkout_started
Type: Recommended event
Triggered: When a user navigates to the checkout page
Data source: Braze REST API
Use Case: Checkout abandonment

For Abandoned Checkout Canvases, you first need to use the following Liquid tag:

1
2

{% shopping_cart {{context.${cart_id}}} :abort_if_not_abandoned false %}
{{context.${cart_id}}}

Then you can add the following Liquid tags into your message to reference the products within your cart at the point of checkout.

Variable Liquid templating
cart_id {{ shopping_cart.cart_id }}
currency {{ shopping_cart.currency }}
total_value {{ shopping_cart.total_value }}
product_id {{ shopping_cart.products[0].product_id }}
product_name {{ shopping_cart.products[0].product_name }}
variant_id {{ shopping_cart.products[0].variant_id }}
image_url {{ shopping_cart.products[0].image_url }}
product_url {{ shopping_cart.products[0].product_url }}
quantity {{ shopping_cart.products[0].quantity }}
price {{ shopping_cart.products[0].price }}
sku {{ shopping_cart.products[0].metadata.sku }}
source {{ shopping_cart.source }}
checkout_url {{ shopping_cart.metadata[0].checkout_url }}

Event: ecommerce.order_placed
Type: Recommended event
Triggered: When a user successfully completes the checkout process and places an order
Data source: Braze REST API
Use Case: Order confirmation, post-purchase retargeting, upsells or cross-sells

Variable Liquid templating
cart_id {{event_properties.${cart_id}}}
currency {{event_properties.${currency}}}
discounts {{event_properties.${discounts}}}
order_id {{event_properties.${order_id}}}
product_id {{event_properties.${products}[0].product_id}}
product_name {{event_properties.${products}[0].product_name}}
variant_id {{event_properties.${products}[0].variant_id}}
quantity {{event_properties.${products}[0].quantity}}
sku {{event_properties.${products}[0].metadata.sku}}
total_discounts {{event_properties.${total_discounts}}}
order_status_url {{event_properties.${metadata}.order_status_url}}
order_number {{event_properties.${metadata}.order_number}}
tags {{event_properties.${metadata}.tags}}
referring_site {{event_properties.${metadata}.referring_site}}
payment_gateway_names {{event_properties.${metadata}.payment_gateway_names}}

Event: shopify_fulfilled_order
Type: Custom Event
Triggered: When a user’s order is fulfilled and ready for shipping
Data source: Braze REST API
Use Case: (Transactional) Fulfillment update

Variable Liquid templating
Order ID {{event_properties.${order_id}}}
Total Price {{event_properties.${total_price}}}
Total Discounts {{event_properties.${total_discounts}}}
Confirmed Status {{event_properties.${confirmed}}}
Order Status URL {{event_properties.${order_status_url}}}
Order Number {{event_properties.${order_number}}}
Cancelled Timestamp {{event_properties.${cancelled_at}}}
Closed Timestamp {{event_properties.${closed_at}}}
Item ID {{event_properties.${line_items}[0].product_id}}
Item Quantity {{event_properties.${line_items}[0].quantity}}
Item SKU {{event_properties.${line_items}[0].sku}}
Item Title {{event_properties.${line_items}[0].title}}
Item Vendor {{event_properties.${line_items}[0].vendor}}
Item Name {{event_properties.${line_items}[0].name}}
Item Properties {{event_properties.${line_items}[0].properties}}
Item Price {{event_properties.${line_items}[0].price}}
Shipping Title {{event_properties.${shipping}[0].title}}
Shipping Price {{event_properties.${shipping}[0].price}}
Fulfillment Status {{event_properties.${fulfillment_status}}}
Fulfillment Shipment Status {{event_properties.${fulfillments}[0].shipment_status}}
Status {{event_properties.${fulfillments}[0].status}}
Fulfillment Tracking Company {{event_properties.${fulfillments}[0].Fulfillment tracking_company}}
Fulfillment Tracking Number {{event_properties.${fulfillments}[0].Fulfillment tracking_number}}
Fulfillment Tracking Numbers {{event_properties.${fulfillments}[0].Fulfillment tracking_numbers}}
Fulfillment Tracking URL {{event_properties.${fulfillments}[0].Fulfillment tracking_url}}
Fulfillment Tracking URLs {{event_properties.${fulfillments}[0].Fulfillment tracking_urls}}
Fulfillment Status {{event_properties.${fulfillments}[0].line_items[0].fulfillment_status}}
Fulfillment Name {{event_properties.${fulfillments}[0].line_items[0].name}}
Fulfillment Price {{event_properties.${fulfillments}[0].line_items[0].price}}
Fulfillment Product ID {{event_properties.${fulfillments}[0].line_items[0].product_id}}
Fulfillment Quantity {{event_properties.${fulfillments}[0].line_items[0].quantity}}
Fulfillment Shipping {{event_properties.${fulfillments}[0].line_items[0].requires_shipping}}
Fulfillment SKU {{event_properties.${fulfillments}[0].line_items[0].sku}}
Fulfillment Title {{event_properties.${fulfillments}[0].line_items[0].title}}
Fulfillment Vendor {{event_properties.${fulfillments}[0].line_items[0].vendor}}
Variant ID {{event_properties.${line_items}[0].variant_id}}
Variant Title {{event_properties.${line_items}[0].variant_title}}

Event: shopify_partially_fulfilled_order
Type: Custom Event
Triggered: When part of a user’s order is fulfilled and ready for shipping
Data source: Braze REST API
Use Case: (Transactional) Fulfillment update

Variable Liquid templating
Order ID {{event_properties.${order_id}}}
Total Price {{event_properties.${total_price}}}
Total Discounts {{event_properties.${total_discounts}}}
Confirmed Status {{event_properties.${confirmed}}}
Order Status URL {{event_properties.${order_status_url}}}
Order Number {{event_properties.${order_number}}}
Cancelled Timestamp {{event_properties.${cancelled_at}}}
Closed Timestamp {{event_properties.${closed_at}}}
Item ID {{event_properties.${line_items}[0].product_id}}
Item Quantity {{event_properties.${line_items}[0].quantity}}
Item SKU {{event_properties.${line_items}[0].sku}}
Item Title {{event_properties.${line_items}[0].title}}
Item Vendor {{event_properties.${line_items}[0].vendor}}
Item Name {{event_properties.${line_items}[0].name}}
Item Properties {{event_properties.${line_items}[0].properties}}
Item Price {{event_properties.${line_items}[0].price}}
Shipping Title {{event_properties.${shipping}[0].title}}
Shipping Price {{event_properties.${shipping}[0].price}}
Fulfillment Status {{event_properties.${fulfillment_status}}}
Fulfillment Shipment Status {{event_properties.${fulfillments}[0].shipment_status}}
Fulfillment Status {{event_properties.${fulfillments}[0].status}}
Fulfillment Tracking Company {{event_properties.${fulfillments}[0].tracking_company}}
Fulfillment Tracking Number {{event_properties.${fulfillments}[0].tracking_number}}
Fulfillment Tracking Numbers {{event_properties.${fulfillments}[0].tracking_numbers}}
Fulfillment Tracking URL {{event_properties.${fulfillments}[0].tracking_url}}
Fulfillment Tracking URLs {{event_properties.${fulfillments}[0].tracking_urls}}
Fulfillment Status {{event_properties.${fulfillments}[0].line_items[0].fulfillment_status}}
Fulfillment Name {{event_properties.${fulfillments}[0].line_items[0].name}}
Fulfillment Price {{event_properties.${fulfillments}[0].line_items[0].price}}
Fulfillment Product ID {{event_properties.${fulfillments}[0].line_items[0].product_id}}
Fulfillment Quantity {{event_properties.${fulfillments}[0].line_items[0].quantity}}
Fulfillment Shipping {{event_properties.${fulfillments}[0].line_items[0].requires_shipping}}
Fulfillment SKU {{event_properties.${fulfillments}[0].line_items[0].sku}}
Fulfillment Title {{event_properties.${fulfillments}[0].line_items[0].title}}
Fulfillment Vendor {{event_properties.${fulfillments}[0].line_items[0].vendor}}
Variant ID {{event_properties.${line_items}[0].variant_id}}
Variant Title {{event_properties.${line_items}[0].variant_title}}

Event: shopify_paid_order
Type: Custom Event
Triggered: When a user’s order is marked as paid within Shopify
Data source: Braze REST API
Use Case: (Transactional) Payment confirmation

Variable Liquid templating
Order ID {{event_properties.${order_id}}}
Confirmed Status {{event_properties.${confirmed}}}
Order Status URL {{event_properties.${order_status_url}}}
Order Number {{event_properties.${order_number}}}
Cancelled Timestamp {{event_properties.${cancelled_at}}}
Total Discounts {{event_properties.${total_discounts}}}
Total Price {{event_properties.${total_price}}}
Tags {{event_properties.${tags}}}
Discount Codes {{event_properties.${discount_codes}}}
Item ID {{event_properties.${line_items}[0].product_id}}
Item Quantity {{event_properties.${line_items}[0].quantity}}
Item SKU {{event_properties.${line_items}[0].sku}}
Item Title {{event_properties.${line_items}[0].title}}
Item Vendor {{event_properties.${line_items}[0].vendor}}
Item Properties {{event_properties.${line_items}[0].properties}}
Item Price {{event_properties.${line_items}[0].price}}
Shipping Title {{event_properties.${shipping}[0].title}}
Shipping Price {{event_properties.${shipping}[0].price}}
Variant ID {{event_properties.${line_items}[0].variant_id}}
Variant Title {{event_properties.${line_items}[0].variant_title}}

Event: shopify_cancelled_order
Type: Custom Event
Triggered: When a user’s order is cancelled
Data source: Braze REST API
Use Case: (Transactional) Order cancellation confirmation

Variable Liquid templating
Order ID {{event_properties.${order_id}}}
Total Price {{event_properties.${total_price}}}
Total Discounts {{event_properties.${total_discounts}}}
Confirmed {{event_properties.${confirmed}}}
Order Status URL {{event_properties.${order_status_url}}}
Order Number {{event_properties.${order_number}}}
Cancelled Timestamp {{event_properties.${cancelled_at}}}
Tags {{event_properties.${tags}}}
Discount Codes {{event_properties.${discount_codes}}}
Fulfillment Status {{event_properties.${fulfillment_status}}}
Fulfillments {{event_properties.${fulfillments}}}
Item ID {{event_properties.${line_items}[0].product_id}}
Item Quantity {{event_properties.${line_items}[0].quantity}}
Item SKU {{event_properties.${line_items}[0].sku}}
Item Title {{event_properties.${line_items}[0].title}}
Item Vendor {{event_properties.${line_items}[0].vendor}}
Item Name {{event_properties.${line_items}[0].name}}
Item Properties {{event_properties.${line_items}[0].properties}}
Fulfillment Status {{event_properties.${line_items}[0].fulfillment_status}}
Shipping Title {{event_properties.${shipping}[0].title}}
Shipping Price {{event_properties.${shipping}[0].price}}
Variant ID {{event_properties.${line_items}[0].variant_id}}
Variant Title {{event_properties.${line_items}[0].variant_title}}

Event: shopify_order_refunded
Type: Custom Event
Triggered: When a user’s order is refunded
Data source: Braze REST API
Use Case: (Transactional) Refund confirmation

Variable Liquid templating
Order ID {{event_properties.${order_id}}}
Order Note {event_properties.${note}}}
Item ID {{event_properties.${line_items}[0].product_id}}
Item Quantity {{event_properties.${line_items}[0].quantity}}
Item SKU {{event_properties.${line_items}[0].sku}}
Item Title {{event_properties.${line_items}[0].title}}
Item Vendor {{event_properties.${line_items}[0].vendor}}
Item Name {{event_properties.${line_items}[0].name}}
Item Properties {{event_properties.${line_items}[0].properties}}
Item Price {{event_properties.${line_items}[0].price}}
Variant ID {{event_properties.${line_items}[0].variant_id}}
Variant Title {{event_properties.${line_items}[0].variant_title}}

Event: shopify_account_login
Type: Custom Event
Triggered: When a user logs into their account
Data source: Braze REST API
Use Case: Welcome series

Variable Liquid templating
source {{event_properties.${source}}}

Supported Shopify custom attributes

1
2
3
4
5
6
7
8
9
10
11
12
13

{
  "attributes": [
    {
      "shopify_tags": "VIP_customer",
      "shopify_total_spent": "60.00",
      "shopify_order_count": "3",
      "shopify_last_order_id": "1234567",
      "shopify_last_order_name": "test_order",
      "shopify_zipcode": "10001",
      "shopify_province": "null"
    }
  ]
}
Attribute Name Description
shopify_total_spent The total amount of money that the customer has spent across their order history.
shopify_order_count The number of orders associated with this customer. Test and archived orders aren’t counted.
shopify_last_order_id The ID of the customer’s last order.
shopify_last_order_name The name of the customer’s last order. This is directly related to the name field on the order resource.
shopify_zipcode The customer’s zipcode from their default address.
shopify_province The customer’s province from their default address.

Liquid personalization

To add Liquid personalization for your Shopify custom attributes, select + Personalization. Then select Custom Attributes as your personalization type.

The "Add Personalization" section with the "Attribute" dropdown extended.

After selecting your custom attribute, input a default value and copy the Liquid snippet into your message.

Pasting a Liquid snippet into a message.

Supported Shopify standard attributes

  • Email
  • First Name
  • Last Name
  • Phone
  • City
  • Country

SDK data collection

For more information on what data is collected by the Braze SDKs, see SDK data collection.

Historical backfill

Historical Shopify data is imported from before you connect Braze—order events from the past 90 days and customer data from the past year. Both timeframes are counted back from the date you complete your integration.

Through the Shopify standard integration setup or Shopify custom integration setup, you can turn on historical backfill to target past customers. This imports your Shopify orders (order-related events) from the past 90 days and user profiles from the past year. Both timeframes are counted back from the date you complete your integration.

When Braze imports your Shopify customers, we assign the external_id type that you chose in your configuration settings.

If you plan to integrate with a custom external ID (for either the standard integration or the custom integration), you will be required to add your custom external ID as a Shopify customer metafield to all existing Shopify customer profiles and then perform the historical backfill.

Setting up Shopify historical backfill

  1. Turn on historical backfill in the Track Shopify data step.

The "Track Shopify data" step of the Shopify integration showing historical backfill selected.

  1. After you complete your integration setup, Braze will begin the initial data sync. You can monitor progress on the Shopify Data tab of your integration settings.

The Shopify Integration Settings page with a spinner showing that events are actively syncing.

Synced data

For the initial data sync, Braze imports order events from the past 90 days and user profiles from the past year, each counted back from the date you complete your integration. When Braze imports your Shopify customers, it assigns the external_id type that you chose in your configuration settings.

The following table summarizes the data included in that initial load.

Braze recommended events Shopify custom events Braze standard attributes Braze subscription statuses
  • Order placed
  • Order cancelled
  • Order refunded
  • shopify_tags
  • shopify_total_spent
  • shopify_order_count
  • shopify_last_order_id
  • shopify_last_order_name
  • shopify_zipcode
  • shopify_province
  • Email
  • First Name
  • Last Name
  • Phone
  • City
  • Country
  • Total Revenue
  • Total Refunds
  • Total Orders
  • Email marketing subscriptions associated with this Shopify store
  • SMS marketing subscriptions associated with this Shopify store
New Stuff!