Retrieve a tracking

GET/shipping/{connection_id}/tracking/{id}

Parameters

Returns

Response field	Type	Required	Description
`id`	string	No	Unique identifier for this tracking object
`created_at`	string (date-time)	No	The date that this tracking object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`updated_at`	string (date-time)	No	The last date that this tracking object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`shipment_id`	string	No	Reference to the shipment
`tracking_number`	string	No	Tracking number for the shipment
`status`	enum	No	Current status of the shipment Values: `PENDING`, `PROCESSING`, `IN_TRANSIT`, `DELIVERED`, `EXCEPTION`, `CANCELLED`, `LABEL_CREATED`, `PICKED_UP`, `OUT_FOR_DELIVERY`, `DELIVERY_ATTEMPTED`, `RETURNED_TO_SENDER`, `HELD_AT_LOCATION`, `CUSTOMS_CLEARANCE`, `EXCEPTION_RESOLVED`
`events`	ShippingTrackingEvent[]	No	Array of tracking events
`events[].created_at`	string (date-time)	No	The date that this tracking event object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`events[].description`	string	No	Description of the tracking event
`events[].status`	enum	No	Status at the time of this event Values: `PENDING`, `PROCESSING`, `IN_TRANSIT`, `DELIVERED`, `EXCEPTION`, `CANCELLED`, `LABEL_CREATED`, `PICKED_UP`, `OUT_FOR_DELIVERY`, `DELIVERY_ATTEMPTED`, `RETURNED_TO_SENDER`, `HELD_AT_LOCATION`, `CUSTOMS_CLEARANCE`, `EXCEPTION_RESOLVED`
`events[].event_code`	string	No	Carrier-specific event code
`events[].carrier_status_code`	string	No	Carrier's status code at this event
`events[].location_address`	ShippingTrackingEvent_location_address	No
`events[].location_address.address1`	string	No
`events[].location_address.address2`	string	No
`events[].location_address.city`	string	No
`events[].location_address.region`	string	No
`events[].location_address.region_code`	string	No
`events[].location_address.postal_code`	string	No
`events[].location_address.country`	string	No
`events[].location_address.country_code`	string	No	ISO 2-digit country code
`events[].location_address.name`	string	No	Recipientsender name
`events[].location_address.company_name`	string	No	Company name (for commercial addresses)
`events[].location_address.telephone`	string	No	Phone number (required by FedEx, UPS, DHL)
`events[].location_address.email`	string	No	Email address (for delivery notifications)
`events[].location_address.is_residential`	boolean	No	Alias for address_type === 'RESIDENTIAL'
`events[].location_address.is_validated`	boolean	No	Whether address has been validated
`events[].location_address.delivery_instructions`	string	No	Special delivery notes
`events[].location_id`	string	No	Location ID; points to CommerceLocation (reference to ShippingLocation)
`events[].location_name`	string	No	Location name
`events[].notes`	string	No	Additional notes
`events[].signed_by`	string	No	Who signed for delivery
`estimated_delivery`	string (date-time)	No	Estimated delivery date
`actual_delivery_at`	string (date-time)	No	Actual delivery timestamp (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
`status_description`	string	No	Human-readable status
`carrier_id`	string	No	Reference to the carrier
`carrier_status_code`	string	No	Carrier's status code
`carrier_status_description`	string	No	Carrier's status description

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}

Status	Error	Meaning
`400`	Bad Request	The request was malformed or failed validation.
`401`	Unauthorized	The connection is likely broken; re-authorize it.
`403`	Forbidden	The connection is missing permissions or scopes.
`404`	Not Found	The requested resource does not exist.
`429`	Too Many Requests	Rate limit exceeded (see the two sources below).
`500`	Internal Server Error	An unexpected error occurred.
`501`	Not Implemented	Not supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

The integration's own rate limit, passed through.
Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.

const options = {
  method: 'GET',
  url: 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/tracking/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Code Samples

Node.js SDK

import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.shipping.getShippingTracking({ connectionId, id, 
    fields: '',
    raw: '',
 });

Node.js (axios)

const options = {
  method: 'GET',
  url: 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/tracking/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);

Java

AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/shipping/5de520f96e439b002043d8dc/tracking/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Go

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/shipping/5de520f96e439b002043d8dc/tracking/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)

Python

import requests

url = "https://api.unified.to/shipping/5de520f96e439b002043d8dc/tracking/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)

PHP

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/shipping/5de520f96e439b002043d8dc/tracking/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);

Ruby

require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/shipping/5de520f96e439b002043d8dc/tracking/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body

cURL

curl --request GET \
  --url 'https://api.unified.to/shipping/5de520f96e439b002043d8dc/tracking/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'

Are we missing anything? Let us know

Was this page helpful?