{
  "event": "shipup_event",
  "customer_properties": {
    "$email": "[email protected]"
  },
  "properties": {
    "subject": "I'm a subject",
    "title": "I'm a title",
    "body": "I'm a body",
    "source": "Order",
    "notification__category": "package_delivered",
    "notification__slug": "package_delivered_to_3rd_party",
    "notification__tracking_link": "https://api.shipup.co/v1/notifications/tracking_link?notification_uuid=7f1f875b-c4b2-43c9-8e39-4666ee303ee4",
    "notification__survey_links": {
      "satisfied": "https://api.shipup.co/v1/notifications/survey?notification_uuid=7f1f875b-c4b2-43c9-8e39-4666ee303ee4&satisfied=happy",
      "dissatisfied": "https://api.shipup.co/v1/notifications/survey?notification_uuid=7f1f875b-c4b2-43c9-8e39-4666ee303ee4&satisfied=unhappy"
    },
    "order__custom_variables": {
      "custom": "order_variable"
    },
    "order__email": "[email protected]",
    "order__first_name": "Héloise",
    "order__fulfillment_count": 0,
    "order__full_name": "Héloise",
    "order__language_code": "en",
    "order__last_name": null,
    "order__order_number": "ABCD123",
    "order__ordered_at": 1542399900,
    "order__phone": null,
    "order__tracker_count": 0,
    "line_items": [
      {
        "canceled_quantity": null,
        "canceled": null,
        "custom_variables": null,
        "description": null,
        "merchant_id": "LINE_ITEM_M_UNFULFILLED_ID_1",
        "name": null,
        "quantity": null,
        "requires_shipping": null,
        "shipped_quantity": null,
        "sku": "LINE_ITEM_UNFULFILLED_SKU_1",
        "thumbnail": {
          "src": "https://imgurl.com/foo.jpg",
          "width": "300",
          "height": "100"
        },
        "title": null,
        "variant_title": null
      }
    ]
  },
  "time": 1542745500
}
{
  "event": "shipup_event",
  "customer_properties": {
    "$email": "[email protected]"
  },
  "properties": {
    "subject": "I'm a subject",
    "title": "I'm a title",
    "body": "I'm a body",
    "source": "Fulfillment",
    "notification__category": "package_delivered",
    "notification__slug": "package_delivered_to_3rd_party",
    "notification__tracking_link": "https://api.shipup.co/v1/notifications/tracking_link?notification_uuid=7f1f875b-c4b2-43c9-8e39-4666ee303ee4",
    "order__custom_variables": {
      "custom": "order_variable"
    },
    "order__email": "[email protected]",
    "order__first_name": "Héloise",
    "order__fulfillment_count": 1,
    "order__full_name": "Héloise",
    "order__language_code": "en",
    "order__last_name": null,
    "order__order_number": "ABCD123",
    "order__ordered_at": 1542399900,
    "order__phone": null,
    "order__tracker_count": 0,
    "fulfillment__custom_variables": {
      "custom": "fulfillment_variable"
    },
    "fulfillment__fulfillment_number": "XYZABCD_1",
    "fulfillment__merchant_id": "internal_id_1234",
    "shipping_address__comment": null,
    "shipping_address__city": "Paris",
    "shipping_address__country": "France",
    "shipping_address__country_code": "FR",
    "shipping_address__state": null,
    "shipping_address__address1": "1, rue de Rivoli",
    "shipping_address__address2": null,
    "shipping_address__zip": "75001",
    "shipping_address__company_title": "ACME Corp",
    "shipping_address__first_name": "John",
    "shipping_address__last_name": "Doe",
    "shipping_address__display_address": "John Doe<br>ACME Corp<br>1, rue de Rivoli<br>75001 Paris<br>France",
    "shipping_address__can_be_displayed": true,
    "line_items": [
      {
        "canceled_quantity": null,
        "canceled": null,
        "custom_variables": null,
        "description": null,
        "merchant_id": "LINE_ITEM_FULFILLED_M_ID_1",
        "name": null,
        "quantity": null,
        "requires_shipping": null,
        "shipped_quantity": null,
        "sku": "LINE_ITEM_FULFILLED_SKU_1",
        "thumbnail": {
          "src": "https://imgurl.com/foo.jpg",
          "width": "300",
          "height": "100"
        },
        "title": null,
        "variant_title": null
      }
    ]
  },
  "time": 1542745500
}
{
  "event": "shipup_event",
  "customer_properties": {
    "$email": "[email protected]"
  },
  "properties": {
    "subject": "I'm a subject",
    "title": "I'm a title",
    "body": "I'm a body",
    "source": "Order",
    "notification__category": "package_delivered",
    "notification__slug": "package_delivered_to_3rd_party",
    "notification__tracking_link": "https://api.shipup.co/v1/notifications/tracking_link?notification_uuid=7f1f875b-c4b2-43c9-8e39-4666ee303ee4",
    "order__custom_variables": {
      "custom": "order_variable"
    },
    "order__email": "[email protected]",
    "order__first_name": "Héloise",
    "order__fulfillment_count": 0,
    "order__full_name": "Héloise",
    "order__language_code": "en",
    "order__last_name": null,
    "order__order_number": "ABCD123",
    "order__ordered_at": 1542399900,
    "order__phone": null,
    "order__tracker_count": 0,
    "line_items": [
      {
        "canceled_quantity": null,
        "canceled": null,
        "custom_variables": null,
        "description": null,
        "merchant_id": "LINE_ITEM_M_UNFULFILLED_ID_1",
        "name": null,
        "quantity": null,
        "requires_shipping": null,
        "shipped_quantity": null,
        "sku": "LINE_ITEM_UNFULFILLED_SKU_1",
        "thumbnail": {
          "src": "https://imgurl.com/foo.jpg",
          "width": "300",
          "height": "100"
        },
        "title": null,
        "variant_title": null
      }
    ]
  },
  "time": 1542745500
}

After you setup Klaviyo as a notification channel, Shipup will send the corresponding notifications to your account with the following format:

FIELDDESCRIPTION
event
string
Value is "shipup_event"
customer_properties
object
Object with an $email property corresponding to the order.email linked with this notification
properties
object
Properties of the notification. See format below
time
datetime
Time at which the notification occurred

The properties field object of the payload will have the following format:

FIELDDESCRIPTION
subject
string
Subject as setup in the corresponding notification setting
title
string
Title as setup in the corresponding notification setting
body
string
Body as setup in the corresponding notification setting
source
string
Could be Order, Fulfillment or Tracker depending on the resource attached to the notification
notification__*Notification properties. See the notification object and additional specific Klaviyo properties in the table below
order__*Order properties. See the order object and additional specific Klaviyo properties in the table below
fulfillment__*Fulfillment properties. See the fulfillment object.
Will only be present if source is Fulfillment or Tracker
shipping_address__*Address properties. See the address object and additional specific Klaviyo properties in the table below.
Will only be present if an address is linked to the source of the notification
tracker__*Tracker properties. See the tracker object and additional specific Klaviyo properties in the table below.
Will only be present if source is Tracker
tracker_carrier__*Carrier properties. See the carrier field of the tracker object.
Will only be present if source is Tracker
line_items
array
Array of line_items linked to the source. See the line item object

In addition to the properties described in the object references, Shipup will add the following ones:

FIELDDESCRIPTION
notification__tracking_link
string
Link to the merchant's tracking page
notification__survey_links
object with 2 keys ("satisfied" and "dissatisfied")
Only available if the notification category is package_delivered.
The links will redirect the end-user to the survey platform as if the end-user had clicked on the "satisfied' or "dissatisfied" button in Shipup delivered notification.
order__full_name
string
Concatenation of the customer's first_name and last_name. Will consist of only last name or first name if the other one is missing
order__fulfillment_count
integer
Count of fulfillments for the linked order
order__tracker_count
integer
Count of trackers for the linked order
shipping_address__display_address
string
Pre-formatted address in HTML format. The representation will vary depending on the destination country to match local standards
shipping_address__can_be_displayed
boolean
Will be true if the address is complete, i.e. if it contains a recipient, address line, zip code, and city
tracker__expected_delivery_date
string, format is mm/dd/yyyy or mm/dd/yyyy depending on the destination country
Corresponds to the tracker displayable_expected_delivery_date attribute
tracker__order_shipment_rank
integer
Shipment rank of the current tracker for its order.
e.g., if one package is already shipped, this rank will be 2 for the 2nd package when shipped. Value is null if the package is not shipped yet.
Will only be present if the source is Tracker
tracker__has_pickup_point
boolean
Will be true for trackers set to be delivered at a pickup point
tracker__pickup_changed
boolean
Will be true for trackers set to be delivered to a pickup point, and the initially chosen pickup point can't receive the package
tracker__pickup_point
object
If the tracker is set to be delivered to a pickup_point, will contain the address, phone and opening information for the pickup_point, when available. Object keys are:
tracker__pick_up_point.opening_hours : object (see example values in Tracker payload)
tracker__pick_up_point.closed_dates: object (see example values in Tracker payload)
tracker__pick_up_point.special_openings: object (see example values in Tracker payload)
tracker__pick_up_point.phone: string
tracker__pick_up_point.address: object (see example values in Tracker payload)
tracker__pick_up_point.map: object (see example values in Tracker payload)
tracker__carrier_tracking_url
string
Link to the carrier's tracking page for a specific tracker