What data is available inside of Integration events?

Brian Whalley Updated by Brian Whalley

All integration and webhook events come with the following metadata for use in personalization, segmentation, and analytics.

Event Data Property Name

Example Data

Notes

BusinessDaysSinceFulfillmentCreated

5

CarrierName

ups

Not usually used in email templates (Often this is what a 3PL inputs into Shopify)

CarrierNameFriendly

Australia Post

CurrentStatus

SHIPMENT_CREATED

IN_TRANSIT

OUT_FOR_DELIVERY

DELIVERED

this is an incomplete list of possible values

CustomerTags

[VIP, Active Subscriber]

Shopify Customer Tags

DeliveredAt (optional)

11/09/2022 04:57

Only in Shipment Delivered

(Can be formatted in Klaviyo templates - documentation)

DiscountApplications

{
  Type: "PERCENTAGE", 
  Value: 20, 
  DiscountCode: "WELCOME"
}

An object containing any discounts applied to the order, with the specific details of the discount.

DestinationCountryCode

US

EstimatedPackageDelivery

08/27/2022

An ETA Provided by the carrier

MM/DD/YYYY

EventDate

2022-09-07T20:43:00.000Z

A timestamp record of when the carrier reports the event occurring. (Can be formatted in Klaviyo templates - documentation)

EventLocation (optional)

{ 
    City: "Louisville", 
    State: "KY", 
    Zip: "", 
    Country: "US" 
}

The location where the event took place, such as a sorting facility

FulfillmentCreatedDate

2022-09-19T15:46:35.000Z

UTC formatted timestamp. (Can be formatted in Klaviyo templates - documentation)

FulfillmentAddress

{
  Address1: "75 Northern Ave", 
  City: "Boston", 
  StateCode: "MA", 
  CountryCode: "US",
  Zip: "02210"
}

The address of the shipment origin

HoursStalled (optional)

25

Only in Shipment Stalled events.

The number of hours since the last reported movement of the shipment

NotUpdatedSince (optional)

9/1/2020 2:46 PM ET

Only in Shipment Stalled events

OrderCreatedDate

OrderNumber

#AD12345

The Shopify Order Name

OrderID

2113541212

The Shopify Order ID

ServiceLevel

Priority Mail

2nd Day Air®

this is an incomplete list of possible values

ServiceLevelCode

usps_priority

ups_second_day_air

this is an incomplete list of possible values

ServiceLevelFriendlyName

Priority Mail

Same as ServiceLevel

ShippingAddress

{
  Address1: "1 City Hall Square", 
  City: "Boston", 
  StateCode: "MA",  
  CountryCode: "US",
  Zip: "02201"
}

The address of the shipment destination

ProductNames

["Purple Squirrel", "Orange Squirrel"]

LineItemsCount

3

LineItems

An object containing the line-item contents of the order (see below)

OrderStatusURL

https://your-store.com/9414996/orders/20359b1424df49d1af4e2df3c907e2ff/authenticate?key=1ad16e9fc9ff9b793c562e70b76cac2b

A link to the customer facing Shopify branded orders status page

OrderSubtotal

15

In Klaviyo you can use the floatformat filter to format your currency values. Learn more

OrderTags

[Subscription, Subscription Recurring Order]

Shopify Order Tags

OrderTax

4.44

OrderShipping

5.99

OrderTotal

20.99

Skus

["PS-10000", "PS-10000-O"]

Substatus (optional)

package_departed

package_processing

this is an incomplete list of possible values

SubstatusMessage (optional)

"Arrived at regional sort facility."

A human readable message you can safely include in your email template, provided by the carrier

TrackingCode

1Z111111

TrackingURL

http://www.fedex.com/Tracking?language=english&tracknumbers=61290980851223631052

This will match the URL in the Shopify admin order screen

WondermentAdminShipmentPage

https://app.wonderment.com/shipment/1Z099693YW90060172

This is useful for internal notifications about specific shipments.

StorefrontTrackingURL

https://your-store.com/pages/tracking?search=AD-12345

This is useful for showing the entire status of orders for Shopify app block pages.

WondermentOrderTrackingURL

https://your-store.com/apps/wonderment/tracking?search=AD-12345

This is useful for showing the entire status of multi-fulfillment orders

WondermentTrackingURL

https://your-store.com/apps/wonderment/tracking?search=1Z111111

In addition to the basic information about the order, the LineItems field contains an array of information about each line item in the order. You can reference this data for building templates, branching logic based on package contents, and so on. This is stored in a 0-indexed array, so you can easily access an individual item or loop over it to get the entire contents.This product data is retrieved from Shopify and stored by Wonderment as the event is generated. As such, the events regarding a specific fulfillment will reflect the product's data at the time of order. Updates to product catalog data will be reflected in future fulfillments, but not change the data for in-progress fulfillments. This data reflects contents of a specific fulfillment, not order contents, so items not in this fulfillment (ie in another package from a different fulfillment center), or that do not require fulfillment (such as digital gift cards, ebooks, etc) will not appear in this listing. If Split Shipments are enabled, data about other items not in this fulfillment will be in a separate array defined below.

Event Data Property Name

Example Data

Notes

LineItemID

12227587965126

SKU

PS-10000

Quantity

1

ProductURL

https://domain.com/products/super-soft-shirt

The URL of the product's detail page

ProductID

8446445319

The Shopify Product ID

ProductName

Super Soft T-Shirt

The main title of the product

ProductImage

https://cdn.shopify.com/path/to/image.jpg

The featured image for the product

ProductImageAltText

A picture of a t-shirt

VariantID

27219729543

The Shopify Variant ID

VariantName

Extra Large / Blue

A combination of the variant options (such as size and color) separated by "/"

VariantImage

https://cdn.shopify.com/path/to/image-variant.jpg

The associated image with the variant. Learn more

VariantImageAltText

A picture of the blue t-shirt

CustomAttributes

"CustomAttributes": [
 {  
  "Key": "embroidery",
  "Value": "VIP"
 }
]

An object containing any line item properties, read more below

Discount

5.00

The item's price after discounts were applied. This value reflects the price they actually paid.

Price

50.00

The item's normal price.

Taxable

TRUE

CurrencyCode

USD

Weight

100

WeightUnit

grams

In addition to the basic information about the line items, there is an array that contains any custom data attached to the line item, such as a gift note or other data. This is stored in a simple key-value pair in the array for each piece of metadata.

Custom Attribute

Example Data

giftNote

Your Message

SubscriptionInterval

1 month

In addition to the basic information about the order, there are two arrays, FulfillmentAddress and ShippingAddress, which contain the From and To addresses for the order. They follow the same pattern, except there are no first/last name fields on the FulfillmentAddress.

Event Data Property Name

Example Data

FirstName

Examplename

LastName

Lastname

Address1

1 City Hall Square

Address2

Room 500

City

Boston

StateCode

MA

Zip

02210

CountryCode

US

There is also an array that contains the fine details provided by the carrier on where a carrier event happened. For example, this might be the warehouse where a given transit scan occurred. This data is provided as the carrier offers it, so the exact data available may vary by carrier.

Event Location

Example Data

City

Boston

State

MA

Zip

02210

Country

US

There is also an array that contains any discounts applied to the order. There is usually a maximum of one discount applied per order, but in some cases (like with a store-wide discount) there may be two or more.

Discount Application

Example Data

Type

PERCENTAGE

Value

15

DiscountCode

Promo_Code_Used

There is also additional data available about split shipments if you enable Wonderment's Split Shipments Data.

Learn more: Creating A Split Shipment Email

Event Data Property Name

Example Data

OtherShipmentsInThisOrder

An array (see below) of other shipments in the order, and their line items

TotalShipments

The total number of fulfillments in this order.

LineItemsFloating

A line items array of any fulfillable products in the order, but not attached to any fulfillments. These are any "yet to ship" products, backordered products, or similar.

How did we do?

Upgrading Your Klaviyo Integration

Contact