GOgoshippo
Tracking Status

Register a tracking webhook

Changed on

Registers a webhook that will send HTTP notifications to you when the status of your tracked package changes. For more details on creating a webhook, see our guides on Webhooks and Tracking.

post/tracks

Request

  • Base URL
    https://api.goshippo.com
  • URL
    https://api.goshippo.com/tracks
  • Auth
    API key in header Authorization

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

SHIPPO-ACCOUNT-IDstring

Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the Platform accounts guide.

Request body

carrierstring required

Name of the carrier of the shipment to track.

metadatastring

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

tracking_numberstring required

Tracking number to track.

Example request

{
  "carrier": "usps",
  "metadata": "Order 000123",
  "tracking_number": "9205590164917312751089"
}

Response

Tracking status

carrierstring required

Name of the carrier of the shipment to track. See Carriers.

etastring date-time

The estimated time of arrival according to the carrier, this might be updated by carriers during the life of the shipment.

messagesstring[] required
metadatastring

A string of up to 100 characters that can be filled with any additional information you want to attach to the object.

original_etastring date-time

The estimated time of arrival according to the carrier at the time the shipment first entered the system.

tracking_numberstring required

Tracking number to track.

transactionstring

The object_id of the transaction associated with this tracking object. This field is visible only to the object owner of the transaction.

Example response

{
  "address_from": {
    "city": "Las Vegas",
    "country": "US",
    "state": "NV",
    "zip": "89101"
  },
  "address_to": {
    "city": "Las Vegas",
    "country": "US",
    "state": "NV",
    "zip": "89101"
  },
  "carrier": "usps",
  "metadata": "Order 000123",
  "original_eta": "2021-07-23T00:00:00Z",
  "servicelevel": {
    "name": "Priority Mail Express",
    "terms": "ONERATE",
    "token": "usps_priority_express",
    "parent_servicelevel": {
      "name": "Priority Mail Express",
      "terms": "ONERATE",
      "token": "usps_priority_express"
    }
  },
  "tracking_history": [
    {
      "location": {
        "city": "Las Vegas",
        "country": "US",
        "state": "NV",
        "zip": "89101"
      },
      "status": "DELIVERED",
      "substatus": {
        "code": "information_received",
        "text": "Information about the package received."
      },
      "status_date": "2016-07-23T00:00:00Z",
      "status_details": "Your shipment has been delivered at the destination mailbox."
    }
  ],
  "tracking_number": "9205590164917312751089",
  "tracking_status": {
    "location": {
      "city": "Las Vegas",
      "country": "US",
      "state": "NV",
      "zip": "89101"
    },
    "status": "DELIVERED",
    "substatus": {
      "code": "information_received",
      "text": "Information about the package received."
    },
    "status_date": "2016-07-23T00:00:00Z",
    "status_details": "Your shipment has been delivered at the destination mailbox."
  }
}

Changes