Articles in this section

Zendesk package API specification

Overview

Shipup provides an API endpoint exposing a set of order information related to a specific customer. This is particularly useful for customer support tools. This endpoint was originally built for our Zendesk integration but it can be consumed by any other source. Calling this endpoint with a specific email address query will return all orders placed in the las month by the customer related to this email address. Additional information provided include:

The packages for this order, including their delivery statuses.

All shipping events for those packages.

All notifications sent by Shipup for those packages.

Authentication

A unique private API key can be found in your admin settings to authenticate your API requests.

You must authenticate every API request by including an Authorization header. This header should include the Authorization type of Bearer, followed by your API key:

Authorization: Bearer [PRIVATE_API_KEY]

Warning: Your private API key must remain secret. A public API key is also available in your account but is only used to authenticate your tracking page.

The body of the response will follow the JSON API specification. See below for more details.

Response body

The body will follow the JSON API specification.When calling the zendesk package API you will receive an array of trackers type object.Each tracker will have relationships of type events and notifications.All events and notifications of the trackers will be included in the tracker.See below for detailed data specifications of trackers, events and notifications.

Tracker format

The response of the request contains tracker objects. Following the JSON API specification, each tracker object will contain those 5 attributes:

"id": 1234 (unique Shipup ID for the tracker)
"type": "trackers" (object type. Will always be 'trackers' for this object)
"attributes": ATTRIBUTES (attributes of the tracker, see below)
"relationships": RELATIONSHIPS (relationships of the tracker: 'events' and 'notifications')
"included": INCLUDED (included relationships of the tracker: 'events', 'notifications' and 'notificationTypes')

Most attributes can be found in the data specification. Here is a detailed description of the remaining attributes:

Field

Description

createdAt

datetime

Date when the tracker was received by Shipup

trackingLink

string

URL redirecting to the tracking page of the tracker on the shipping carrier's website

expeditionDate

datetime

Time at which the tracker was shipped by the carrier

firstDeliveryAttempt

datetime

Time at which the first carrier presentation was made, or time at which the package first reached a pickup point

deliveryDate

datetime

Time at which the tracker was delivered

muteNotifications

boolean

When set to true, the tracker will not generate notifications. Will be set to true if the customer unsubscribes from notifications.

Event format

Following the JSON API specification, event objects will have three attributes:

"id": 1234 (unique Shipup ID for the event)
"type": "events" (object type. Will always be 'events' for this object)
"attributes": ATTRIBUTES (attributes of the event, see below)

Notification format

Following the JSON API specification, notification objects will have four attributes:

"id": 1234 (unique Shipup ID for the notification)
"type": "notifications" (object type. Will always be 'notifications' for this object)
"attributes": ATTRIBUTES (attributes of the notification, see below)"relationships": RELATIONSHIPS (relationships of the notification: 'notificationType', 'tracker' and 'company')

Here is the specification for notification attributes:

Field

Description

createdAt

datetime

Time at which the notification was created by Shipup

trackerId

string

Unique Shipup ID of the tracker that generated this notification

channelStatus

object

Delivery status for each notification channel

channelStatus.email.sent

boolean

When set to true, the notification was sent

channelStatus.email.status

string

Email status. Possible values are:

created

delivered

open

click

NotificationType format

Following the JSON API specification, notificationType objects will have three attributes:

"id": 1234 (unique Shipup ID for the notification)
"type": "notifications" (object type. Will always be 'notifications' for this object)
"attributes": ATTRIBUTES (attributes of the notification, see below)