Create Branded Tracking Page Url
This API allows you to create a tracking page for a specific shipment. A unique URL will be generated for each tracking page.
info
Carrier Accounts Required!
With the exception of Fedex, UPS and USPS any tracking pages created will also require your account to have a connection to that carrier. To learn about connecting carriers see Setup a Carrier.
Example
POST /v-beta/tracking_page/
POST /v-beta/tracking_page HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"tracking_pages" :[
{
"branded_tracking_theme_guid" : "fc16e39d-9722-4514-aff5-75e1f24c5bbd",
"tracking_number" : "012345678910",
"carrier_code" : "ups",
"service_code" : "ups_ground",
"to_city_locality" :"austin",
"to_state_province" : "tx",
"to_postal_code" : "78756",
"to_country_code" : "US",
"from_city_locality" :"denver",
"from_state_province" : "CO",
"from_postal_code" : "80014",
"from_country_code" : "US"
}
]
}
curl -iX POST https://api.shipengine.com/v-beta/tracking_page \
-H 'API-Key: __YOUR_API_KEY_HERE__' \
-H 'Content-Type: application/json' \
-d '{
"tracking_pages" :[
{
"branded_tracking_theme_guid" : "fc16e39d-9722-4514-aff5-75e1f24c5bbd",
"tracking_number" : "012345678910",
"carrier_code" : "ups",
"service_code" : "ups_ground",
"to_city_locality" :"austin",
"to_state_province" : "tx",
"to_postal_code" : "78756",
"to_country_code" : "US",
"from_city_locality" :"denver",
"from_state_province" : "CO",
"from_postal_code" : "80014",
"from_country_code" : "US"
}
]
}'
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("Host", "api.shipengine.com")
$headers.Add("API-Key", "__YOUR_API_KEY_HERE__")
$headers.Add("Content-Type", "application/json")
$body = "{`n `"tracking_pages`" :[`n {`n `"branded_tracking_theme_guid`" : `"fc16e39d-9722-4514-aff5-75e1f24c5bbd`",`n `"tracking_number`" : `"012345678910`",`n `"carrier_code`" : `"ups`",`n `"service_code`" : `"ups_ground`",`n `"to_city_locality`" :`"austin`",`n `"to_state_province`" : `"tx`",`n `"to_postal_code`" : `"78756`",`n `"to_country_code`" : `"US`",`n `"from_city_locality`" :`"denver`",`n `"from_state_province`" : `"CO`",`n `"from_postal_code`" : `"80014`",`n `"from_country_code`" : `"US`"`n`n }`n ]`n}"
$response = Invoke-RestMethod 'https://api.shipengine.com/v-beta/tracking_page' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json
var myHeaders = new Headers();
myHeaders.append("Host", "api.shipengine.com");
myHeaders.append("API-Key", "__YOUR_API_KEY_HERE__");
myHeaders.append("Content-Type", "application/json");
var raw = JSON.stringify({"tracking_pages":[{"branded_tracking_theme_guid":"fc16e39d-9722-4514-aff5-75e1f24c5bbd","tracking_number":"012345678910","carrier_code":"ups","service_code":"ups_ground","to_city_locality":"austin","to_state_province":"tx","to_postal_code":"78756","to_country_code":"US","from_city_locality":"denver","from_state_province":"CO","from_postal_code":"80014","from_country_code":"US"}]});
var requestOptions = {
method: 'POST',
headers: myHeaders,
body: raw,
redirect: 'follow'
};
fetch("https://api.shipengine.com/v-beta/tracking_page", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
var request = require('request');
var options = {
'method': 'POST',
'url': 'https://api.shipengine.com/v-beta/tracking_page',
'headers': {
'Host': 'api.shipengine.com',
'API-Key': '__YOUR_API_KEY_HERE__',
'Content-Type': 'application/json'
},
body: JSON.stringify({"tracking_pages":[{"branded_tracking_theme_guid":"fc16e39d-9722-4514-aff5-75e1f24c5bbd","tracking_number":"012345678910","carrier_code":"ups","service_code":"ups_ground","to_city_locality":"austin","to_state_province":"tx","to_postal_code":"78756","to_country_code":"US","from_city_locality":"denver","from_state_province":"CO","from_postal_code":"80014","from_country_code":"US"}]})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.shipengine.com/v-beta/tracking_page",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS =>"{\n \"tracking_pages\" :[\n {\n \"branded_tracking_theme_guid\" : \"fc16e39d-9722-4514-aff5-75e1f24c5bbd\",\n \"tracking_number\" : \"012345678910\",\n \"carrier_code\" : \"ups\",\n \"service_code\" : \"ups_ground\",\n \"to_city_locality\" :\"austin\",\n \"to_state_province\" : \"tx\",\n \"to_postal_code\" : \"78756\",\n \"to_country_code\" : \"US\",\n \"from_city_locality\" :\"denver\",\n \"from_state_province\" : \"CO\",\n \"from_postal_code\" : \"80014\",\n \"from_country_code\" : \"US\"\n\n }\n ]\n}",
CURLOPT_HTTPHEADER => array(
"Host: api.shipengine.com",
"API-Key: __YOUR_API_KEY_HERE__",
"Content-Type: application/json"
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
import requests
url = "https://api.shipengine.com/v-beta/tracking_page"
payload = "{\n \"tracking_pages\" :[\n {\n \"branded_tracking_theme_guid\" : \"fc16e39d-9722-4514-aff5-75e1f24c5bbd\",\n \"tracking_number\" : \"012345678910\",\n \"carrier_code\" : \"ups\",\n \"service_code\" : \"ups_ground\",\n \"to_city_locality\" :\"austin\",\n \"to_state_province\" : \"tx\",\n \"to_postal_code\" : \"78756\",\n \"to_country_code\" : \"US\",\n \"from_city_locality\" :\"denver\",\n \"from_state_province\" : \"CO\",\n \"from_postal_code\" : \"80014\",\n \"from_country_code\" : \"US\"\n\n }\n ]\n}"
headers = {
'Host': 'api.shipengine.com',
'API-Key': '__YOUR_API_KEY_HERE__',
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data = payload)
print(response.text.encode('utf8'))
require "uri"
require "net/http"
url = URI("https://api.shipengine.com/v-beta/tracking_page")
https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Host"] = "api.shipengine.com"
request["API-Key"] = "__YOUR_API_KEY_HERE__"
request["Content-Type"] = "application/json"
request.body = "{\n \"tracking_pages\" :[\n {\n \"branded_tracking_theme_guid\" : \"fc16e39d-9722-4514-aff5-75e1f24c5bbd\",\n \"tracking_number\" : \"012345678910\",\n \"carrier_code\" : \"ups\",\n \"service_code\" : \"ups_ground\",\n \"to_city_locality\" :\"austin\",\n \"to_state_province\" : \"tx\",\n \"to_postal_code\" : \"78756\",\n \"to_country_code\" : \"US\",\n \"from_city_locality\" :\"denver\",\n \"from_state_province\" : \"CO\",\n \"from_postal_code\" : \"80014\",\n \"from_country_code\" : \"US\"\n\n }\n ]\n}"
response = https.request(request)
puts response.read_body
var client = new RestClient("https://api.shipengine.com/v-beta/tracking_page");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("Host", "api.shipengine.com");
request.AddHeader("API-Key", "__YOUR_API_KEY_HERE__");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n \"tracking_pages\" :[\n {\n \"branded_tracking_theme_guid\" : \"fc16e39d-9722-4514-aff5-75e1f24c5bbd\",\n \"tracking_number\" : \"012345678910\",\n \"carrier_code\" : \"ups\",\n \"service_code\" : \"ups_ground\",\n \"to_city_locality\" :\"austin\",\n \"to_state_province\" : \"tx\",\n \"to_postal_code\" : \"78756\",\n \"to_country_code\" : \"US\",\n \"from_city_locality\" :\"denver\",\n \"from_state_province\" : \"CO\",\n \"from_postal_code\" : \"80014\",\n \"from_country_code\" : \"US\"\n\n }\n ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"tracking_pages\" :[\n {\n \"branded_tracking_theme_guid\" : \"fc16e39d-9722-4514-aff5-75e1f24c5bbd\",\n \"tracking_number\" : \"012345678910\",\n \"carrier_code\" : \"ups\",\n \"service_code\" : \"ups_ground\",\n \"to_city_locality\" :\"austin\",\n \"to_state_province\" : \"tx\",\n \"to_postal_code\" : \"78756\",\n \"to_country_code\" : \"US\",\n \"from_city_locality\" :\"denver\",\n \"from_state_province\" : \"CO\",\n \"from_postal_code\" : \"80014\",\n \"from_country_code\" : \"US\"\n\n }\n ]\n}");
Request request = new Request.Builder()
.url("https://api.shipengine.com/v-beta/tracking_page")
.method("POST", body)
.addHeader("Host", "api.shipengine.com")
.addHeader("API-Key", "__YOUR_API_KEY_HERE__")
.addHeader("Content-Type", "application/json")
.build();
Response response = client.newCall(request).execute();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.shipengine.com/v-beta/tracking_page"
method := "POST"
payload := strings.NewReader("{\n \"tracking_pages\" :[\n {\n \"branded_tracking_theme_guid\" : \"fc16e39d-9722-4514-aff5-75e1f24c5bbd\",\n \"tracking_number\" : \"012345678910\",\n \"carrier_code\" : \"ups\",\n \"service_code\" : \"ups_ground\",\n \"to_city_locality\" :\"austin\",\n \"to_state_province\" : \"tx\",\n \"to_postal_code\" : \"78756\",\n \"to_country_code\" : \"US\",\n \"from_city_locality\" :\"denver\",\n \"from_state_province\" : \"CO\",\n \"from_postal_code\" : \"80014\",\n \"from_country_code\" : \"US\"\n\n }\n ]\n}")
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
}
req.Header.Add("Host", "api.shipengine.com")
req.Header.Add("API-Key", "__YOUR_API_KEY_HERE__")
req.Header.Add("Content-Type", "application/json")
res, err := client.Do(req)
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
fmt.Println(string(body))
}
#import <Foundation/Foundation.h>
dispatch_semaphore_t sema = dispatch_semaphore_create(0);
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://api.shipengine.com/v-beta/tracking_page"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
NSDictionary *headers = @{
@"Host": @"api.shipengine.com",
@"API-Key": @"__YOUR_API_KEY_HERE__",
@"Content-Type": @"application/json"
};
[request setAllHTTPHeaderFields:headers];
NSData *postData = [[NSData alloc] initWithData:[@"{\n \"tracking_pages\" :[\n {\n \"branded_tracking_theme_guid\" : \"fc16e39d-9722-4514-aff5-75e1f24c5bbd\",\n \"tracking_number\" : \"012345678910\",\n \"carrier_code\" : \"ups\",\n \"service_code\" : \"ups_ground\",\n \"to_city_locality\" :\"austin\",\n \"to_state_province\" : \"tx\",\n \"to_postal_code\" : \"78756\",\n \"to_country_code\" : \"US\",\n \"from_city_locality\" :\"denver\",\n \"from_state_province\" : \"CO\",\n \"from_postal_code\" : \"80014\",\n \"from_country_code\" : \"US\"\n\n }\n ]\n}" dataUsingEncoding:NSUTF8StringEncoding]];
[request setHTTPBody:postData];
[request setHTTPMethod:@"POST"];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
if (error) {
NSLog(@"%@", error);
} else {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
NSError *parseError = nil;
NSDictionary *responseDictionary = [NSJSONSerialization JSONObjectWithData:data options:0 error:&parseError];
NSLog(@"%@",responseDictionary);
dispatch_semaphore_signal(sema);
}
}];
[dataTask resume];
dispatch_semaphore_wait(sema, DISPATCH_TIME_FOREVER);
import Foundation
var semaphore = DispatchSemaphore (value: 0)
let parameters = "{\n \"tracking_pages\" :[\n {\n \"branded_tracking_theme_guid\" : \"fc16e39d-9722-4514-aff5-75e1f24c5bbd\",\n \"tracking_number\" : \"012345678910\",\n \"carrier_code\" : \"ups\",\n \"service_code\" : \"ups_ground\",\n \"to_city_locality\" :\"austin\",\n \"to_state_province\" : \"tx\",\n \"to_postal_code\" : \"78756\",\n \"to_country_code\" : \"US\",\n \"from_city_locality\" :\"denver\",\n \"from_state_province\" : \"CO\",\n \"from_postal_code\" : \"80014\",\n \"from_country_code\" : \"US\"\n\n }\n ]\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "https://api.shipengine.com/v-beta/tracking_page")!,timeoutInterval: Double.infinity)
request.addValue("api.shipengine.com", forHTTPHeaderField: "Host")
request.addValue("__YOUR_API_KEY_HERE__", forHTTPHeaderField: "API-Key")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.httpMethod = "POST"
request.httpBody = postData
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
semaphore.signal()
}
task.resume()
semaphore.wait()
{
"tracking_pages": [
{
"carrier_code": "ups",
"tracking_number": "012345678910",
"branded_tracking_theme_guid": "fc16e39d-9722-4514-aff5-75e1f24c5bbd",
"token": "MYkORKpDv02x-LX3yv7bdQ",
"url": "http://track.shipengine.com/se/v1/MYkORKpDv02x-LX3yv7bdQ",
"service_code": "ups_ground"
}
],
"page": 0,
"pages": 0,
"total": 1
}
{
"tracking_pages": [
{
"carrier_code": "ups",
"tracking_number": "012345678910",
"branded_tracking_theme_guid": "fc16e39d-9722-4514-aff5-75e1f24c5bbd",
"token": "MYkORKpDv02x-LX3yv7bdQ",
"url": "http://track.shipengine.com/se/v1/MYkORKpDv02x-LX3yv7bdQ",
"service_code": "ups_ground"
}
],
"page": 0,
"pages": 0,
"total": 1
}