Developer Centre > API References > Tracking Details

StarShipIT

API change history

Tracking Details

Get tracking details using a tracking numbmer

Try it

Request URL


Request parameters

(optional)
string

Tracking number used in the shipment

(optional)
string

The identifier of the order pulled from source e-Commerce platform

Request headers

string

Api key in your StarShipIT account under Settings > API Key

string
Subscription key which provides access to this API. Found in your Profile.

Request body

Response 200

OK

{
  "results": {
    "order_number": "17062",
    "order_status": "Delivered",
    "carrier_name": "DHL",
    "carrier_service": "P",
    "tracking_number": "0000000000",
    "shipment_date": "2017-04-12T13:17:40.5931835",
    "tracking_status": "Delivered",
    "last_updated_date": "2017-04-18T14:59:00",
    "tracking_events": [
      {
        "event_datetime": "2017-04-12T15:22:45",
        "status": "Dispatched",
        "details": "Shipment picked up (PU)"
      },
      {
        "event_datetime": "2017-04-12T17:53:59",
        "status": "In Transit",
        "details": "Departed Facility in MELBOURNE - AUSTRALIA (DF)"
      },
      {
        "event_datetime": "2017-04-13T09:42:00",
        "status": "In Transit",
        "details": "Arrived at Sort Facility LOS ANGELES GATEWAY,CA-USA (AF)"
      },
      {
        "event_datetime": "2017-04-15T10:23:00",
        "status": "In Transit",
        "details": "Forwarded for delivery (FD)"
      },
      {
        "event_datetime": "2017-04-15T13:03:00",
        "status": "Attempted Delivery",
        "details": "Delivery attempted; recipient not home (NH)"
      },
      {
        "event_datetime": "2017-04-18T14:59:00",
        "status": "Delivered",
        "details": "Delivered - Signed for by (OK)"
      }
    ]
  },
  "success": true
}
{
  "type": "object",
  "properties": {
    "results": {
      "type": "object",
      "properties": {
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "type": "string"
        },
        "order_status": {
          "description": "The status of the order (e.g. Unshipped, Awaiting Dispatch, Dispatched and Delivered)",
          "type": "string"
        },
        "carrier_name": {
          "description": "Name of the carrier used for shipment delivery",
          "type": "string"
        },
        "carrier_service": {
          "description": "Carrier product service used for shipment delivery",
          "type": "string"
        },
        "tracking_number": {
          "description": "Carrier tracking number",
          "type": "string"
        },
        "shipment_date": {
          "format": "date-time",
          "description": "The date when shipment was picked up",
          "type": "string"
        },
        "tracking_status": {
          "description": "Last tracking status from the carrier",
          "type": "string"
        },
        "last_updated_date": {
          "format": "date-time",
          "description": "Last tracking updated date from the carrier",
          "type": "string"
        },
        "tracking_events": {
          "description": "List of detailed tracking event from the carrier",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "event_datetime": {
                "format": "date-time",
                "description": "Date and time of the carrier scan or event",
                "type": "string"
              },
              "status": {
                "description": "Status of the event",
                "type": "string"
              },
              "details": {
                "description": "Description of the event",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
{
  "results": {
    "order_number": "string",
    "order_status": "string",
    "carrier_name": "string",
    "carrier_service": "string",
    "tracking_number": "string",
    "shipment_date": "string",
    "tracking_status": "string",
    "last_updated_date": "string",
    "tracking_events": [
      {
        "event_datetime": "string",
        "status": "string",
        "details": "string"
      }
    ]
  },
  "success": true,
  "errors": [
    {
      "message": "string",
      "details": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "results": {
      "type": "object",
      "properties": {
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "type": "string"
        },
        "order_status": {
          "description": "The status of the order (e.g. Unshipped, Awaiting Dispatch, Dispatched and Delivered)",
          "type": "string"
        },
        "carrier_name": {
          "description": "Name of the carrier used for shipment delivery",
          "type": "string"
        },
        "carrier_service": {
          "description": "Carrier product service used for shipment delivery",
          "type": "string"
        },
        "tracking_number": {
          "description": "Carrier tracking number",
          "type": "string"
        },
        "shipment_date": {
          "format": "date-time",
          "description": "The date when shipment was picked up",
          "type": "string"
        },
        "tracking_status": {
          "description": "Last tracking status from the carrier",
          "type": "string"
        },
        "last_updated_date": {
          "format": "date-time",
          "description": "Last tracking updated date from the carrier",
          "type": "string"
        },
        "tracking_events": {
          "description": "List of detailed tracking event from the carrier",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "event_datetime": {
                "format": "date-time",
                "description": "Date and time of the carrier scan or event",
                "type": "string"
              },
              "status": {
                "description": "Status of the event",
                "type": "string"
              },
              "details": {
                "description": "Description of the event",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<GetTrackingResponse>
  <results>
    <order_number>string</order_number>
    <order_status>string</order_status>
    <carrier_name>string</carrier_name>
    <carrier_service>string</carrier_service>
    <tracking_number>string</tracking_number>
    <shipment_date>string</shipment_date>
    <tracking_status>string</tracking_status>
    <last_updated_date>string</last_updated_date>
    <tracking_events>
      <event_datetime>string</event_datetime>
      <status>string</status>
      <details>string</details>
    </tracking_events>
  </results>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</GetTrackingResponse>
{
  "type": "object",
  "properties": {
    "results": {
      "type": "object",
      "properties": {
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "type": "string"
        },
        "order_status": {
          "description": "The status of the order (e.g. Unshipped, Awaiting Dispatch, Dispatched and Delivered)",
          "type": "string"
        },
        "carrier_name": {
          "description": "Name of the carrier used for shipment delivery",
          "type": "string"
        },
        "carrier_service": {
          "description": "Carrier product service used for shipment delivery",
          "type": "string"
        },
        "tracking_number": {
          "description": "Carrier tracking number",
          "type": "string"
        },
        "shipment_date": {
          "format": "date-time",
          "description": "The date when shipment was picked up",
          "type": "string"
        },
        "tracking_status": {
          "description": "Last tracking status from the carrier",
          "type": "string"
        },
        "last_updated_date": {
          "format": "date-time",
          "description": "Last tracking updated date from the carrier",
          "type": "string"
        },
        "tracking_events": {
          "description": "List of detailed tracking event from the carrier",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "event_datetime": {
                "format": "date-time",
                "description": "Date and time of the carrier scan or event",
                "type": "string"
              },
              "status": {
                "description": "Status of the event",
                "type": "string"
              },
              "details": {
                "description": "Description of the event",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}
<GetTrackingResponse>
  <results>
    <order_number>string</order_number>
    <order_status>string</order_status>
    <carrier_name>string</carrier_name>
    <carrier_service>string</carrier_service>
    <tracking_number>string</tracking_number>
    <shipment_date>string</shipment_date>
    <tracking_status>string</tracking_status>
    <last_updated_date>string</last_updated_date>
    <tracking_events>
      <event_datetime>string</event_datetime>
      <status>string</status>
      <details>string</details>
    </tracking_events>
  </results>
  <success>true</success>
  <errors>
    <message>string</message>
    <details>string</details>
  </errors>
</GetTrackingResponse>
{
  "type": "object",
  "properties": {
    "results": {
      "type": "object",
      "properties": {
        "order_number": {
          "description": "The identifier of the order pulled from source e-Commerce platform",
          "type": "string"
        },
        "order_status": {
          "description": "The status of the order (e.g. Unshipped, Awaiting Dispatch, Dispatched and Delivered)",
          "type": "string"
        },
        "carrier_name": {
          "description": "Name of the carrier used for shipment delivery",
          "type": "string"
        },
        "carrier_service": {
          "description": "Carrier product service used for shipment delivery",
          "type": "string"
        },
        "tracking_number": {
          "description": "Carrier tracking number",
          "type": "string"
        },
        "shipment_date": {
          "format": "date-time",
          "description": "The date when shipment was picked up",
          "type": "string"
        },
        "tracking_status": {
          "description": "Last tracking status from the carrier",
          "type": "string"
        },
        "last_updated_date": {
          "format": "date-time",
          "description": "Last tracking updated date from the carrier",
          "type": "string"
        },
        "tracking_events": {
          "description": "List of detailed tracking event from the carrier",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "event_datetime": {
                "format": "date-time",
                "description": "Date and time of the carrier scan or event",
                "type": "string"
              },
              "status": {
                "description": "Status of the event",
                "type": "string"
              },
              "details": {
                "description": "Description of the event",
                "type": "string"
              }
            }
          }
        }
      }
    },
    "success": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "details": {
            "type": "string"
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X GET "https://api.starshipit.com/api/track?tracking_number={string}&order_number={string}"
-H "StarShipIT-Api-Key: "
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("StarShipIT-Api-Key", "");
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["tracking_number"] = "{string}";
            queryString["order_number"] = "{string}";
            var uri = "https://api.starshipit.com/api/track?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.starshipit.com/api/track");

            builder.setParameter("tracking_number", "{string}");
            builder.setParameter("order_number", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("StarShipIT-Api-Key", "");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "tracking_number": "{string}",
            "order_number": "{string}",
        };
      
        $.ajax({
            url: "https://api.starshipit.com/api/track?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("StarShipIT-Api-Key","");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.starshipit.com/api/track";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"tracking_number={string}",
                         @"order_number={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"StarShipIT-Api-Key"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.starshipit.com/api/track');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'StarShipIT-Api-Key' => '',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'tracking_number' => '{string}',
    'order_number' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'StarShipIT-Api-Key': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'tracking_number': '{string}',
    'order_number': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.starshipit.com')
    conn.request("GET", "/api/track?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'StarShipIT-Api-Key': '',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'tracking_number': '{string}',
    'order_number': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.starshipit.com')
    conn.request("GET", "/api/track?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.starshipit.com/api/track')

query = URI.encode_www_form({
    # Request parameters
    'tracking_number' => '{string}',
    'order_number' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['StarShipIT-Api-Key'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body