Specifications for e-commerce events

When you run your e-commerce campaigns, having the correct customer data helps you to give your customers a more personalized shopping experience by understanding their likes and dislikes. Using this data, you can find new opportunities to market products, refine your campaigns, and identify customers at risk for churn. This leads to better customer satisfaction and customer retention.

As customers browse your site, you can send the interaction data to Blueshift as Events. Blueshift can also generate derived events (synthetic events generated when specific criteria are met) based on a combination of customer metadata, transactions, browsing behavior, and catalog/content changes to specify the criteria to trigger such events.

Here are some events you can send to Blueshift and the information we recommend you include.

  Important

  • You must include at least one customer identifier in the event data. In case the customer is anonymous, include the value of the cookie.
  • An event_uuid is assigned to the event in Blueshift. Alternatively, you can include an event_uuid in the event data. This event_uuid must be unique and must be in the format 1234abcd-efghijkj-1234kfjadslk-34iu123. For more information about the UUID format, see RFC 4122.
Event Description
Pageload Page loaded completely
Identify Add or update customer
Signed_up Customer signed up on your site or app
View Item viewed
Search Customer searched for item
Add to Cart Item added to cart
Checkout Order checked out started
Last Saved Cart

Last cart contents for a saved checkout.

Requires URL to cart or ability to rebuild items in the cart.

Purchase Checkout completed
Shipped Order shipped
Returned Item returned
Canceled Order canceled
Favorited Item added to favorites
Wishlist Item added to wishlist
Login Customer logged into an account or app
Logout Customer logged out

Pageload

Trigger this event before a page of your site loads to track a visit to a page. You can also use this event to load Blueshift's tracking pixel.

Field Mandatory Standard
event_uuid No Yes
event Yes Yes
customer identifier Yes Yes
cookie Yes Yes
referrer No No
product_ids Yes Yes
url No No

Sample event:

{   "cookie": "27dac91f-f039-c58d-1b0b-ce42034f2ab1",
  "event": "pageload",
   "ip": "66.249.83.79",
  "referrer": "https://gtm-msr.appspot.com/render?id=GTM-5WTM5XC",
   "timestamp": "2023-06-04T20:58:08.094Z",
  "url": "https://gtm-msr.appspot.com/render2?id=GTM-5WTM5XC",
 "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36"}

Sample record/process event:

{  "_bsft_ts": "2023-06-04T20:58:08.094Z",
  "account_uuid": "1740c68d-0e89-437e-8b2b-1599c9cef2cf",
  "cookie": "27dac91f-f039-c58d-1b0b-ce42034f2ab1",
  "event": "pageload",
  "event_uuid": "be6dcd9a-045b-4282-aeb0-bc914de3b5df",
  "ip": "66.249.83.79",
  "referrer": "https://gtm-msr.appspot.com/render?id=GTM-5WTM5XC",
  "site": "shopify.blueshiftimp.com",
  "timestamp": "2023-06-04T20:58:08.094Z",
  "timestamp_epoch": 1685912288,
  "url": "https://gtm-msr.appspot.com/render2?id=GTM-5WTM5XC",
 "user_agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Safari/537.36"}

Identify

Trigger this event when a customer signs up or when you can identify if the customer has logged in. You can also use this event to add or update a user attribute for a known customer. You can include additional attributes of the customer that you can then use for personalization in a campaign.

Field Required Standard
event_uuid No Yes
event Yes Yes
customer identifier Yes Yes
cookie Yes Yes
url No No

Sample event:

{  "cookie": "5471c7f9-4035-3ecb-6693-5687e67d9ca1",
  "ip": "34.68.77.119",
  "event": "identify",
  "email": "testuser@getblueshift.com"}

Sample record/process event:

{  "_bsft_source": "Blueshift Shopify",
  "_bsft_ts": "2023-05-19T17:23:55.988Z",
  "account_uuid": "1740c68d-0e89-437e-8b2b-1599c9cef2cf",
  "cookie": "5471c7f9-4035-3ecb-6693-5687e67d9ca1",
  "event": "identify",
  "event_uuid": "17e62910-0a2e-4ee6-b6e9-12592355c7f8",
  "ip": "34.68.77.119",
  "shop_name": "bsft-imp.myshopify.com",
  "site": "shopify.blueshiftimp.com",
  "timestamp": "2023-05-19T17:23:55.988Z",
  "timestamp_epoch": 1684517035,
 "url": "https://3puiceijefl78wbvh3lqbv57rpjgj67-72685453604.shopifypreview.com/?cb=6cf571288f221c8f2873ae834d4267ca2adc6557a002686ab9c20c96f839e102",
 "user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, .like Gecko) HeadlessChrome/113.0.5672.92 Safari/537.36"}

Sign Up

Record this event when a user with a known user attribute, such as customer_id, email, or phone number, completes the sign-up process. We recommend that you also initiate an 'identify' event immediately after sign_up. The 'sign_up' event will log the user's registration and can be leveraged to trigger campaigns like a welcome campaign. Subsequently, the 'identify' event will merge anonymous and known users, assuming cookie information and identifying attributes are included.

Field Required Standard
event_uuid No Yes
event Yes Yes
customer identifier Yes Yes
cookie No Yes

Sample event:

{ "cookie": "5471c7f9-4035-3ecb-6693-5687e67d9ca1",
"email": "testuser@getblueshift.com",
 "event": "sign_up"}

Sample processed event:

{  "_bsft_source": "Blueshift Shopify",
  "_bsft_ts": "2023-05-18T22:23:46.339Z",
  "account_uuid": "1740c68d-0e89-437e-8b2b-1599c9cef2cf",
 "email": "john.doe@gmail.com",
  "event": "signed_up",
  "event_uuid": "0c3adb6d-4cc7-4a18-a667-7fb3d40c112c",
 "firstname": "John",
 "lastname": "Doe",
  "shop_name": "bsft-imp.myshopify.com",
  "site": "shopify.blueshiftimp.com",
  "timestamp": "2023-05-18T22:23:45.000Z",
  "timestamp_epoch": 1684448625,
  "user_agent": "Faraday v0.17.0"}

View

Trigger this event when a user views a product page on your site or app.

Field Required Standard
event_uuid No Yes
event Yes Yes
customer identifier Yes Yes
cookie Yes Yes
product_ids No Yes
url No No
referrer No No
keyword No No

Sample event:

{  "cookie": "541e586b-e3dd-d6c4-5e26-da703cf23c60",
  "event": "view",
  "product_ids": [
    "44881392992548"
  ]}

Sample processed event:

{  "_bsft_source": "Blueshift Shopify",
  "_bsft_ts": "2023-05-18T22:29:54.045Z",
  "account_uuid": "1740c68d-0e89-437e-8b2b-1599c9cef2cf",
  "cookie": "541e586b-e3dd-d6c4-5e26-da703cf23c60",
  "event": "view",
  "event_uuid": "f38ca5aa-50fc-4f85-9e51-38f24b0f6a01",
  "ip": "23.118.250.177",
  "product_ids": [
    "44881392992548"
  ],
  "referrer": "https://bsft-imp.myshopify.com/",
  "shop_name": "bsft-imp.myshopify.com",
  "site": "shopify.blueshiftimp.com",
  "timestamp": "2023-05-18T22:29:54.045Z",
  "timestamp_epoch": 1684448994,
  "url": "https://bsft-imp.myshopify.com/products/abc-jogger-30",
 "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/113.0.0.0 Safari/537.36"}

Search

Trigger this event when a customer searches for something on your site or app. Using this event, you can record a customer’s interest in an item and use this information in your campaigns.

Field Required Standard
event_uuid No Yes
event Yes Yes
customer identifier Yes Yes
cookie Yes Yes
product_ids No Yes
url No No
referrer No No
keyword No No

Sample event:

{  "cookie": "541e586b-e3dd-d6c4-5e26-da703cf23c60",
  "product_ids": [
    "PRM123",
    "PRM1234",
    "PRM12345"
  ],
  "keyword": "PRM",}

Sample processed event:

{  "_bsft_ts": "2023-08-17T09:36:09.604Z",
  "cookie": "541e586b-e3dd-d6c4-5e26-da703cf23c60",
  "account_uuid": "e512291d-584e-4121-bfe6-fc71faaccc50",
  "bs_geo": [
    73.7652740478516,
    18.5824432373047
  ],
  "bs_geo_source": "device",
  "country_code": "IN",
  "event": "search",
  "event_uuid": "a8055d8e-408d-4b5b-80ff-c1f1f4ca59af",
  "latitude": 18.5824432373047,
  "longitude": 73.7652740478516,
  "product_ids": [
    "PRM123",
    "PRM1234",
    "PRM12345"
  ],
  "keyword": "PRM",
  "site": "blueshiftreads.com",
  "timestamp": "2023-08-17T09:35:54.963Z",
  "timestamp_epoch": 1692264954,
  "user_agent": "Blueshift%20Reads/1 CFNetwork/1408.0.4 Darwin/22.5.0"}

Add to Cart

Trigger this event when a customer adds a product to the cart. You can use this information in an Abandoned Cart campaign if the customer does not purchase this product.

Field Mandatory Standard
event_uuid No Yes
event Yes Yes
Customer identifier Yes Yes
cookie Yes Yes
product_ids Yes Yes
url No No
referrer No No

Sample event:

{  "cookie": "541e586b-e3dd-d6c4-5e26-da703cf23c60",
  "event": "add_to_cart",
  "product_ids": [
    "9780142410370"
  ]}

Sample processed event:

{  "_bsft_event_timestamp": "2023-09-20T10:57:29.176Z",
  "_bsft_transaction_uuid": "2a011d73-461c-42cf-9dec-078879840676",
  "_bsft_ts": "2023-09-20T10:57:29.173Z",
  "cookie": "541e586b-e3dd-d6c4-5e26-da703cf23c60",
  "account_uuid": "e512291d-584e-4121-bfe6-fc71faaccc50",
  "event": "add_to_cart",
  "event_uuid": "701f373a-50e2-459a-83ae-47f39cafd90b",
  "latitude": 18.5824584960938,
  "longitude": 73.7651977539062,
  "product_ids": [
    "9780142410370"
  ],
  "quantity": 1,
  "site": "blueshiftreads.com",
  "sku": "9780142410370",
  "timestamp": "2023-09-20T10:57:28.952Z",
  "timestamp_epoch": 1695207448,
  "user_agent": "Blueshift%20Reads/1 CFNetwork/1474 Darwin/23.0.0",
 "web_url": "https://www.blueshiftreads.com/products/juvenile-fiction-action-adventure-general/matilda"}

Checkout

Trigger this event when a customer views the checkout page and reviews the order before a purchase. If a customer does not purchase, you can use this event to run a campaign for customers who abandon a checkout.

Field Required Standard
event_uuid No Yes
event Yes Yes
customer identifier Yes Yes
cookie Yes Yes
product_ids Yes Yes
products No No
keyword No No

Sample event:

{  "_bsft_source": "Blueshift Shopify",
  "_bsft_ts": "2023-05-18T22:23:45.830Z",
  "account_uuid": "1740c68d-0e89-437e-8b2b-1599c9cef2cf",
  "email": "john.doe@gmail.com",
  "event": "checkout",
  "event_uuid": "c85a5f8f-5324-4341-bcf0-90cd28460ab1",
  "product_ids": [
    "44881391812900"
  ],
  "products": [
    {
      "parent_sku": 8216594383140,
      "price": "89.00",
      "quantity": 1,
      "sku": 44881391812900
    }
  ],
  "shop_name": "bsft-imp.myshopify.com",
  "site": "shopify.blueshiftimp.com",
  "timestamp": "2023-05-18T22:23:45.830Z",
  "timestamp_epoch": 1684448625,
  "total": "89.00",
  "user_agent": "Faraday v0.17.0"}

Purchase

Trigger this event when a customer completes a purchase on your site or app. You can use the data from this event for the following actions:

  • Measure the performance of your campaign
  • Model recommendations to exclude some of the items that a customer has already ordered
  • Calculate customer affinities
Field Required Standard
event_uuid No Yes
event Yes Yes
customer identifier Yes Yes
cookie Yes Yes
product_ids Yes Yes
products No No

Sample event:

{  "account_uuid": "1740c68d-0e89-437e-8b2b-1599c9cef2cf",
  "email": "john.doe@gmail.com",
  "event": "purchase",
  "event_uuid": "c85a5f8f-5324-4341-bcf0-90cd28460ab1",
  "product_ids": [
    "44881391812900"
  ],
  "products": [
    {
      "parent_sku": 8216594383140,
      "price": "89.00",
      "quantity": 1,
      "sku": 44881391812900
    }
  ],
  "shop_name": "bsft-imp.myshopify.com",
  "site": "shopify.blueshiftimp.com",
  "timestamp": "2023-05-18T22:23:45.830Z",
  "timestamp_epoch": 1684448625,
  "total": "89.00",
  "user_agent": "Faraday v0.17.0"}

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Please sign in to leave a comment.