{
  "name": "shipup_event",
  "data": {
    "subject": "I'm a subject",
    "title": "I'm a title",
    "body": "I'm a body",
    "source": "Tracker",
    "notification": {
      "category": "package_delivered",
      "slug": "package_delivered_to_3rd_party",
      "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"
      },
      "email": "[email protected]",
      "first_name": "Héloise",
      "fulfillment_count": 1,
      "full_name": "Héloise",
      "language_code": "en",
      "last_name": null,
      "order_number": "ABCD123",
      "ordered_at": 1542399900,
      "phone": null,
      "tracker_count": 1
    },
    "fulfillment": {
      "custom_variables": {
        "custom": "fulfillment_variable"
      },
      "fulfillment_number": "XYZABCD_1",
      "merchant_id": "internal_id_1234"
    },
    "tracker": {
      "carrier_code": "colissimo",
      "carrier_tracking_url": "http://www.laposte.fr/outils/track-a-parcel?code=AZ123456789BE",
      "custom_variables": null,
      "delivered_at": null,
      "delivery_status_code": "pending",
      "expected_delivery_date": null,
      "first_delivery_attempted_at": null,
      "has_pickup_point": true,
      "order_shipment_rank": null,
      "pickup_changed": null,
      "pickup_point": {
        "opening_hours": {
          "tue": "06:30-19:00"
        },
        "closed_dates": {
          "01/05/2021": true,
          "25/12/2021": true
        },
        "special_openings": {
        },
        "phone": "+33612345678",
        "address": {
          "id": 1,
          "object": "address",
          "comment": null,
          "city": "Paris",
          "country": "France",
          "country_code": "FR",
          "state": null,
          "address1": "1 place du 11 novembre 1918",
          "address2": null,
          "zip": "75010",
          "company_title": null,
          "first_name": null,
          "last_name": null,
          "name": null
        },
        "map": {
          "banner_url": "https://shipup-assets-prod.s3.eu-west-1.amazonaws.com/pickup_point_banners/colissimo/CONSIGNE PICKUP GARE DE L EST/097095.jpg",
          "google_maps_link": "https://www.google.com/maps/search/?api=1&query=48.876932%2C2.359989"
        }
      },
      "shipped_at": null,
      "tracking_number": "AZ123456789BE",
      "carrier": {
        "name": "Colissimo",
        "code": "colissimo"
      }
    },
    "shipping_address": {
      "comment": null,
      "city": "Paris",
      "country": "France",
      "country_code": "FR",
      "state": null,
      "address1": "1, rue de Rivoli",
      "address2": null,
      "zip": "75001",
      "company_title": "ACME Corp",
      "first_name": "John",
      "last_name": "Doe",
      "display_address": "John Doe<br>ACME Corp<br>1, rue de Rivoli<br>75001 Paris<br>France",
      "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": 3,
        "requires_shipping": null,
        "shipped_quantity": 2,
        "sku": "LINE_ITEM_FULFILLED_SKU_1",
        "thumbnail": {
          "src": "https://imgurl.com/foo.jpg",
          "width": "300",
          "height": "100"
        },
        "title": null,
        "variant_title": null
      }
    ]
  }
}
{
  "name": "shipup_event",
  "data": {
    "subject": "I'm a subject",
    "title": "I'm a title",
    "body": "I'm a body",
    "source": "Fulfillment",
    "notification": {
      "category": "package_delivered",
      "slug": "package_delivered_to_3rd_party",
      "tracking_link": "https://api.shipup.co/v1/notifications/tracking_link?notification_uuid=7f1f875b-c4b2-43c9-8e39-4666ee303ee4"
    },
    "order": {
      "custom_variables": {
        "custom": "order_variable"
      },
      "email": "[email protected]",
      "first_name": "Héloise",
      "fulfillment_count": 1,
      "full_name": "Héloise",
      "language_code": "en",
      "last_name": null,
      "order_number": "ABCD123",
      "ordered_at": 1542399900,
      "phone": null,
      "tracker_count": 0
    },
    "fulfillment": {
      "custom_variables": {
        "custom": "fulfillment_variable"
      },
      "fulfillment_number": "XYZABCD_1",
      "merchant_id": "internal_id_1234"
    },
    "shipping_address": {
      "comment": null,
      "city": "Paris",
      "country": "France",
      "country_code": "FR",
      "state": null,
      "address1": "1, rue de Rivoli",
      "address2": null,
      "zip": "75001",
      "company_title": "ACME Corp",
      "first_name": "John",
      "last_name": "Doe",
      "display_address": "John Doe<br>ACME Corp<br>1, rue de Rivoli<br>75001 Paris<br>France",
      "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
      }
    ]
  }
}
{
  "name": "shipup_event",
  "data": {
    "subject": "I'm a subject",
    "title": "I'm a title",
    "body": "I'm a body",
    "source": "Order",
    "notification": {
      "category": "package_delivered",
      "slug": "package_delivered_to_3rd_party",
      "tracking_link": "https://api.shipup.co/v1/notifications/tracking_link?notification_uuid=7f1f875b-c4b2-43c9-8e39-4666ee303ee4"
    },
    "order": {
      "custom_variables": {
        "custom": "order_variable"
      },
      "email": "[email protected]",
      "first_name": "Héloise",
      "fulfillment_count": 0,
      "full_name": "Héloise",
      "language_code": "en",
      "last_name": null,
      "order_number": "ABCD123",
      "ordered_at": 1542399900,
      "phone": null,
      "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
      }
    ]
  }
}

After you setup Customer.io as a notification channel, Shipup will send the corresponding notifications to your account in the following format:

FIELDDESCRIPTION
name
string
Value is "shipup_event"
data
object
Properties of the notification. See the format below

The data payload object 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
object
See the notification object and additional specific Customer.io properties in the table below
order
object
See the order object and additional specific Customer.Io properties in the table below
fulfillment
object
See the fulfillment object.
Will only be present if source is Fulfillment or Tracker.
shipping_address
object
Address properties. See the address object and additional specific Customer.io properties in the table below.
Will only be present if an address is linked to the source of the notification.
tracker
object
Tracker properties. See the tracker object and additional specific Customer.io properties in the table below.
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 adds the following ones to the Customer.io events:

OBJECTFIELDDESCRIPTION
notificationtracking_link
string
Link to the merchant's tracking page for the order
notificationsurvey_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.
orderfull_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
ordertracker_count
integer
Count of trackers for the linked order
orderfulfillment_count
integer
Count of fulfillments for the linked order
shipping_addressdisplay_address
string
Pre-formatted address in HTML format. The representation will vary depending on the destination country, in order to match local standards.
shipping_addresscan_be_displayed
boolean
Will be true if the address is complete, i.e. if it contains a recipient, address line, zip code, and city.
trackerexpected_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
trackerorder_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
trackercarrier_tracking_url
string
Link to the carrier's tracking page for a specific tracker
trackerhas_pickup_point
boolean
Will be true for trackers set to be delivered at a pickup point
trackerpickup_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
trackercarrier
object
See the carrier field of the tracker object.
Will only be present if source is Tracker.
trackerpickup_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.
See the pickup point object in the table below.

Here is the object reference for a pickup point:

FIELDDESCRIPTION
opening_hours
object
Opening hours of a pickup point.
Example: { "mon": "14:00-16:00", "sat": "", "thu": "14:00-16:00" }
closed_dates
object
Closing days of a pickup point.
Example: { "01/08/2021": true, "02/07/2021": true }
special_openings
object
Days where a pickup point is exceptionally open.
Example: { "24/12/2021": true }
phone
string
Phone number of the pickup point
address
object
Address of the pickup point.
See the address object.
map
object
Map of the pickup point. Has two attributes:

- banner_url: URL to a map image of the pickup point's address
- google_maps_link: URL that redirects to the Google Maps location
Example: {"banner_url": "https://shipup.amazonaws.com/pickup_point/123.png", "google_maps_link": "https://www.google.com/maps/search/?api=1&query=123"}