Postmen API docs for StarTrack

Rates

Rates

POST Calculate rates

Try it 
/rates

Calculate rates

NameTypeDescription
shipment * shipment An instance of shipping freight or cargo
async boolean enable async mode or not (set to false if not provided)
is_document boolean If the shipment is document type. (set to false if not provided)
shipper_accounts array of reference accounts for shipment Object reference

	{
	  "shipper_accounts": [
	    {
	      "id": "c9244cf0-297a-43d6-b2a6-fc31637499e6"
	    }
	  ],
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "height": 30,
	          "width": 20,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "contact_name": "contact australia post",
	      "company_name": "A Company",
	      "email": "panda@panda.com",
	      "street1": "Sydney street",
	      "city": "Craigieburn",
	      "postal_code": "3064",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "business",
	      "phone": "1234567890"
	    },
	    "ship_to": {
	      "contact_name": "Buckinghamshire Livingstone West",
	      "company_name": "SICAB PTY LTD",
	      "email": "panda@panda.com",
	      "street1": "Level 2, Suite 4, 55 Norton St.",
	      "city": "St Kilda",
	      "postal_code": "3182",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "residential"
	    }
	  },
	  "async": false
	}
	

	curl --request POST \
	    --url https://sandbox-api.postmen.com/v3/rates \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"shipper_accounts":[{"id":"c9244cf0-297a-43d6-b2a6-fc31637499e6"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"Craigieburn","postal_code":"3064","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"St Kilda","postal_code":"3182","state":"VIC","country":"AUS","type":"residential"}},"async":false}'
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/rates");
	        string json = "{\"shipper_accounts\":[{\"id\":\"c9244cf0-297a-43d6-b2a6-fc31637499e6\"}],\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"height\":30,\"width\":20,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"AUD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]}],\"ship_from\":{\"contact_name\":\"contact australia post\",\"company_name\":\"A Company\",\"email\":\"panda@panda.com\",\"street1\":\"Sydney street\",\"city\":\"Craigieburn\",\"postal_code\":\"3064\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"business\",\"phone\":\"1234567890\"},\"ship_to\":{\"contact_name\":\"Buckinghamshire Livingstone West\",\"company_name\":\"SICAB PTY LTD\",\"email\":\"panda@panda.com\",\"street1\":\"Level 2, Suite 4, 55 Norton St.\",\"city\":\"St Kilda\",\"postal_code\":\"3182\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"residential\"}},\"async\":false}";
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "POST";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        using (StreamWriter streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
	        {
	            streamWriter.Write(json);
	            streamWriter.Flush();
	            streamWriter.Close();
	        }
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	        RequestBody body = RequestBody.create(mediaType, "{\"shipper_accounts\":[{\"id\":\"c9244cf0-297a-43d6-b2a6-fc31637499e6\"}],\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"height\":30,\"width\":20,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"AUD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]}],\"ship_from\":{\"contact_name\":\"contact australia post\",\"company_name\":\"A Company\",\"email\":\"panda@panda.com\",\"street1\":\"Sydney street\",\"city\":\"Craigieburn\",\"postal_code\":\"3064\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"business\",\"phone\":\"1234567890\"},\"ship_to\":{\"contact_name\":\"Buckinghamshire Livingstone West\",\"company_name\":\"SICAB PTY LTD\",\"email\":\"panda@panda.com\",\"street1\":\"Level 2, Suite 4, 55 Norton St.\",\"city\":\"St Kilda\",\"postal_code\":\"3182\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"residential\"}},\"async\":false}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/rates")
	            .post(body)
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'POST',
	    url: 'https://sandbox-api.postmen.com/v3/rates',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"shipper_accounts":[{"id":"c9244cf0-297a-43d6-b2a6-fc31637499e6"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"Craigieburn","postal_code":"3064","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"St Kilda","postal_code":"3182","state":"VIC","country":"AUS","type":"residential"}},"async":false}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/rates';
	    $method = 'POST';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"shipper_accounts":[{"id":"c9244cf0-297a-43d6-b2a6-fc31637499e6"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"Craigieburn","postal_code":"3064","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"St Kilda","postal_code":"3182","state":"VIC","country":"AUS","type":"residential"}},"async":false}';
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
			CURLOPT_POSTFIELDS => $body
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/rates'
	
	payload = '''
	{
	  "shipper_accounts": [
	    {
	      "id": "c9244cf0-297a-43d6-b2a6-fc31637499e6"
	    }
	  ],
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "height": 30,
	          "width": 20,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "contact_name": "contact australia post",
	      "company_name": "A Company",
	      "email": "panda@panda.com",
	      "street1": "Sydney street",
	      "city": "Craigieburn",
	      "postal_code": "3064",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "business",
	      "phone": "1234567890"
	    },
	    "ship_to": {
	      "contact_name": "Buckinghamshire Livingstone West",
	      "company_name": "SICAB PTY LTD",
	      "email": "panda@panda.com",
	      "street1": "Level 2, Suite 4, 55 Norton St.",
	      "city": "St Kilda",
	      "postal_code": "3182",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "residential"
	    }
	  },
	  "async": false
	}
	'''
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('POST', url, data=payload, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/rates')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Post.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	request.body = '{"shipper_accounts":[{"id":"c9244cf0-297a-43d6-b2a6-fc31637499e6"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"Craigieburn","postal_code":"3064","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"St Kilda","postal_code":"3182","state":"VIC","country":"AUS","type":"residential"}},"async":false}'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
id string Calculate Rate ID
status string Accepts: calculating,calculated,failed.
rates array of rate type The amount of a charge or payment with reference to some basis of calculation.
created_at string A formatted date.
updated_at string A formatted date.

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "created_at": "2020-05-22T09:36:06+00:00",
	    "id": "a468d916-9716-40d5-a526-6d1249dcd44a",
	    "updated_at": "2020-05-22T09:36:15+00:00",
	    "status": "calculated",
	    "rates": [
	      {
	        "shipper_account": {
	          "id": "c9244cf0-297a-43d6-b2a6-fc31637499e6",
	          "slug": "star-track",
	          "description": "star-track"
	        },
	        "service_type": "star-track_express",
	        "service_name": "Express",
	        "pickup_deadline": null,
	        "booking_cut_off": null,
	        "delivery_date": null,
	        "transit_time": null,
	        "error_message": null,
	        "info_message": null,
	        "charge_weight": null,
	        "total_charge": {
	          "amount": 15.76,
	          "currency": "AUD"
	        },
	        "detailed_charges": [
	          {
	            "type": "freight charge",
	            "charge": {
	              "amount": 12.48,
	              "currency": "AUD"
	            }
	          },
	          {
	            "type": "total gst",
	            "charge": {
	              "amount": 1.43,
	              "currency": "AUD"
	            }
	          },
	          {
	            "type": "fuel surcharge",
	            "charge": {
	              "amount": 1.85,
	              "currency": "AUD"
	            }
	          }
	        ]
	      },
	      {
	        "shipper_account": {
	          "id": "c9244cf0-297a-43d6-b2a6-fc31637499e6",
	          "slug": "star-track",
	          "description": "star-track"
	        },
	        "service_type": "star-track_fixed_price_premium",
	        "service_name": "1,3 & 5KG Fixed Price Premium",
	        "pickup_deadline": null,
	        "booking_cut_off": null,
	        "delivery_date": null,
	        "transit_time": null,
	        "error_message": null,
	        "info_message": null,
	        "charge_weight": null,
	        "total_charge": {
	          "amount": 20.44,
	          "currency": "AUD"
	        },
	        "detailed_charges": [
	          {
	            "type": "freight charge",
	            "charge": {
	              "amount": 15.65,
	              "currency": "AUD"
	            }
	          },
	          {
	            "type": "total gst",
	            "charge": {
	              "amount": 1.86,
	              "currency": "AUD"
	            }
	          },
	          {
	            "type": "security surcharge",
	            "charge": {
	              "amount": 0.61,
	              "currency": "AUD"
	            }
	          },
	          {
	            "type": "fuel surcharge",
	            "charge": {
	              "amount": 2.32,
	              "currency": "AUD"
	            }
	          }
	        ]
	      }
	    ]
	  }
	}

GET List all rates

Try it 
/rates

List all rates

NameTypeDescription
status string Rate status Accepts: calculating,calculated,failed.
limit string Number of records per page
created_at_min string Start date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: 24hrs ago)
created_at_max string End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: NOW())
next_token string Next token

	{}
	

	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/rates \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/rates");
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "GET";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/rates")
	            .get()
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'GET',
	    url: 'https://sandbox-api.postmen.com/v3/rates',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		}
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/rates';
	    $method = 'GET';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/rates'
	
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('GET', url, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/rates')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Get.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
next_token string or null Any of string or null
limit number Number of records per page
rates array of a rate record object A rate record object

Response example

No example available

GET Retrieve rates

Try it 
/rates/:id

Retrieve rates


	{
	  "shipper_accounts": [
	    {
	      "id": "00000000-0000-0000-0000-000000000000"
	    }
	  ],
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "height": 30,
	          "width": 20,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "contact_name": "contact australia post",
	      "company_name": "A Company",
	      "email": "panda@panda.com",
	      "street1": "Sydney street",
	      "city": "MOUNTAIN GATE",
	      "postal_code": "3156",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "business",
	      "phone": "1234567890"
	    },
	    "ship_to": {
	      "contact_name": "Buckinghamshire Livingstone West",
	      "company_name": "SICAB PTY LTD",
	      "email": "panda@panda.com",
	      "street1": "Level 2, Suite 4, 55 Norton St.",
	      "city": "MOUNTAIN GATE",
	      "postal_code": "2000",
	      "state": "NSW",
	      "country": "AUS",
	      "type": "residential"
	    }
	  },
	  "async": false
	}
	

	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/rates/ \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"shipper_accounts":[{"id":"00000000-0000-0000-0000-000000000000"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"MOUNTAIN GATE","postal_code":"2000","state":"NSW","country":"AUS","type":"residential"}},"async":false}'
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/rates/");
	        string json = "{\"shipper_accounts\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"height\":30,\"width\":20,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"AUD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]}],\"ship_from\":{\"contact_name\":\"contact australia post\",\"company_name\":\"A Company\",\"email\":\"panda@panda.com\",\"street1\":\"Sydney street\",\"city\":\"MOUNTAIN GATE\",\"postal_code\":\"3156\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"business\",\"phone\":\"1234567890\"},\"ship_to\":{\"contact_name\":\"Buckinghamshire Livingstone West\",\"company_name\":\"SICAB PTY LTD\",\"email\":\"panda@panda.com\",\"street1\":\"Level 2, Suite 4, 55 Norton St.\",\"city\":\"MOUNTAIN GATE\",\"postal_code\":\"2000\",\"state\":\"NSW\",\"country\":\"AUS\",\"type\":\"residential\"}},\"async\":false}";
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "GET";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        using (StreamWriter streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
	        {
	            streamWriter.Write(json);
	            streamWriter.Flush();
	            streamWriter.Close();
	        }
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	        RequestBody body = RequestBody.create(mediaType, "{\"shipper_accounts\":[{\"id\":\"00000000-0000-0000-0000-000000000000\"}],\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"height\":30,\"width\":20,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"AUD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]}],\"ship_from\":{\"contact_name\":\"contact australia post\",\"company_name\":\"A Company\",\"email\":\"panda@panda.com\",\"street1\":\"Sydney street\",\"city\":\"MOUNTAIN GATE\",\"postal_code\":\"3156\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"business\",\"phone\":\"1234567890\"},\"ship_to\":{\"contact_name\":\"Buckinghamshire Livingstone West\",\"company_name\":\"SICAB PTY LTD\",\"email\":\"panda@panda.com\",\"street1\":\"Level 2, Suite 4, 55 Norton St.\",\"city\":\"MOUNTAIN GATE\",\"postal_code\":\"2000\",\"state\":\"NSW\",\"country\":\"AUS\",\"type\":\"residential\"}},\"async\":false}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/rates/")
	            .get(body)
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'GET',
	    url: 'https://sandbox-api.postmen.com/v3/rates/',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"shipper_accounts":[{"id":"00000000-0000-0000-0000-000000000000"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"MOUNTAIN GATE","postal_code":"2000","state":"NSW","country":"AUS","type":"residential"}},"async":false}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/rates/';
	    $method = 'GET';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"shipper_accounts":[{"id":"00000000-0000-0000-0000-000000000000"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"MOUNTAIN GATE","postal_code":"2000","state":"NSW","country":"AUS","type":"residential"}},"async":false}';
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
			CURLOPT_POSTFIELDS => $body
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/rates/'
	
	payload = '''
	{
	  "shipper_accounts": [
	    {
	      "id": "00000000-0000-0000-0000-000000000000"
	    }
	  ],
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "height": 30,
	          "width": 20,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "contact_name": "contact australia post",
	      "company_name": "A Company",
	      "email": "panda@panda.com",
	      "street1": "Sydney street",
	      "city": "MOUNTAIN GATE",
	      "postal_code": "3156",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "business",
	      "phone": "1234567890"
	    },
	    "ship_to": {
	      "contact_name": "Buckinghamshire Livingstone West",
	      "company_name": "SICAB PTY LTD",
	      "email": "panda@panda.com",
	      "street1": "Level 2, Suite 4, 55 Norton St.",
	      "city": "MOUNTAIN GATE",
	      "postal_code": "2000",
	      "state": "NSW",
	      "country": "AUS",
	      "type": "residential"
	    }
	  },
	  "async": false
	}
	'''
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('GET', url, data=payload, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/rates/')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Get.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	request.body = '{"shipper_accounts":[{"id":"00000000-0000-0000-0000-000000000000"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"MOUNTAIN GATE","postal_code":"2000","state":"NSW","country":"AUS","type":"residential"}},"async":false}'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
id string Calculate Rate ID
status string Accepts: calculating,calculated,failed.
rates array of rate type The amount of a charge or payment with reference to some basis of calculation.
created_at string A formatted date.
updated_at string A formatted date.

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "created_at": "2019-07-11T07:06:55+00:00",
	    "id": "f2edba61-6c9b-410d-8619-6bf0ca45825d",
	    "updated_at": "2019-07-11T07:07:10+00:00",
	    "status": "calculated",
	    "rates": [
	      {
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track",
	          "description": "star-track"
	        },
	        "service_type": null,
	        "service_name": null,
	        "pickup_deadline": null,
	        "booking_cut_off": null,
	        "delivery_date": null,
	        "transit_time": null,
	        "error_message": null,
	        "info_message": "No rate quotes returned from carrier.",
	        "charge_weight": null,
	        "total_charge": null,
	        "detailed_charges": []
	      }
	    ]
	  }
	}

Labels

Labels

POST Create a label

Try it 
/labels

Create a label

NameTypeDescription
service_type * string Service Types Accepts: star-track_afternoon_2u2day,star-track_cold_chain,star-track_express,star-track_express_courier,star-track_express_half_van,star-track_express_van,star-track_express_wagon,star-track_fixed_price_premium,star-track_immediate_priority_courier,star-track_immediate_priority_half_van,star-track_immediate_priority_van,star-track_immediate_priority_wagon,star-track_on_demand_now,star-track_on_demand_saturday,star-track_on_demand_tonight,star-track_premium,star-track_same_day_2u2day,star-track_saturday_2u2day,star-track_standard_courier,star-track_standard_half_van,star-track_standard_van,star-track_standard_wagon,star-track_twilight_2u2day.
shipper_account * reference Object reference
shipment * shipment An instance of shipping freight or cargo
async boolean enable async mode or not (set to false if not provided)
return_shipment boolean (set to false if not provided)
paper_size string Label Paper Size Accepts: a4,4x6,default. (set to "default" if not provided)
file_type string Label file type Accepts: pdf. (set to "pdf" if not provided)
ship_date string Ship Date in YYYY-MM-DD, if not provided, will be today of the shipper account timezone
service_options array of service option - insurance or service option - general or service option - pickup or service option - dangerous goods Service options
is_document boolean If the shipment is document type. (set to false if not provided)
invoice invoice Invoice object, used to describe invoice type. Optional. Commercial invoice will be generated if field is present in the request body, else not.
references array of strings Reference numbers for a label
billing billing Billing Object
customs customs Customs Object
order_number string A user-defined order number used to identify an order.

	{
	  "service_type": "star-track_express_courier",
	  "return_shipment": false,
	  "shipper_account": {
	    "id": "00000000-0000-0000-0000-000000000000"
	  },
	  "paper_size": "default",
	  "service_options": [
	    {
	      "type": "pickup",
	      "start_time": "17:00:00"
	    }
	  ],
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "height": 30,
	          "width": 20,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "contact_name": "contact australia post",
	      "company_name": "A Company",
	      "email": "panda@panda.com",
	      "street1": "Sydney street",
	      "city": "MOUNTAIN GATE",
	      "postal_code": "3156",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "business",
	      "phone": "1234567890"
	    },
	    "ship_to": {
	      "contact_name": "Buckinghamshire Livingstone West",
	      "company_name": "SICAB PTY LTD",
	      "email": "panda@panda.com",
	      "street1": "Level 2, Suite 4, 55 Norton St.",
	      "city": "MOUNTAIN GATE",
	      "postal_code": "3156",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "residential"
	    }
	  },
	  "billing": {
	    "paid_by": "shipper",
	    "method": {
	      "account_number": "05035861",
	      "type": "account"
	    }
	  },
	  "async": false,
	  "is_document": false,
	  "references": [
	    "950000002"
	  ]
	}
	

	curl --request POST \
	    --url https://sandbox-api.postmen.com/v3/labels \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"service_type":"star-track_express_courier","return_shipment":false,"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"paper_size":"default","service_options":[{"type":"pickup","start_time":"17:00:00"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"residential"}},"billing":{"paid_by":"shipper","method":{"account_number":"05035861","type":"account"}},"async":false,"is_document":false,"references":["950000002"]}'
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/labels");
	        string json = "{\"service_type\":\"star-track_express_courier\",\"return_shipment\":false,\"shipper_account\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"paper_size\":\"default\",\"service_options\":[{\"type\":\"pickup\",\"start_time\":\"17:00:00\"}],\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"height\":30,\"width\":20,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"AUD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]}],\"ship_from\":{\"contact_name\":\"contact australia post\",\"company_name\":\"A Company\",\"email\":\"panda@panda.com\",\"street1\":\"Sydney street\",\"city\":\"MOUNTAIN GATE\",\"postal_code\":\"3156\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"business\",\"phone\":\"1234567890\"},\"ship_to\":{\"contact_name\":\"Buckinghamshire Livingstone West\",\"company_name\":\"SICAB PTY LTD\",\"email\":\"panda@panda.com\",\"street1\":\"Level 2, Suite 4, 55 Norton St.\",\"city\":\"MOUNTAIN GATE\",\"postal_code\":\"3156\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"residential\"}},\"billing\":{\"paid_by\":\"shipper\",\"method\":{\"account_number\":\"05035861\",\"type\":\"account\"}},\"async\":false,\"is_document\":false,\"references\":[\"950000002\"]}";
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "POST";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        using (StreamWriter streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
	        {
	            streamWriter.Write(json);
	            streamWriter.Flush();
	            streamWriter.Close();
	        }
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	        RequestBody body = RequestBody.create(mediaType, "{\"service_type\":\"star-track_express_courier\",\"return_shipment\":false,\"shipper_account\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"paper_size\":\"default\",\"service_options\":[{\"type\":\"pickup\",\"start_time\":\"17:00:00\"}],\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"height\":30,\"width\":20,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"AUD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]}],\"ship_from\":{\"contact_name\":\"contact australia post\",\"company_name\":\"A Company\",\"email\":\"panda@panda.com\",\"street1\":\"Sydney street\",\"city\":\"MOUNTAIN GATE\",\"postal_code\":\"3156\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"business\",\"phone\":\"1234567890\"},\"ship_to\":{\"contact_name\":\"Buckinghamshire Livingstone West\",\"company_name\":\"SICAB PTY LTD\",\"email\":\"panda@panda.com\",\"street1\":\"Level 2, Suite 4, 55 Norton St.\",\"city\":\"MOUNTAIN GATE\",\"postal_code\":\"3156\",\"state\":\"VIC\",\"country\":\"AUS\",\"type\":\"residential\"}},\"billing\":{\"paid_by\":\"shipper\",\"method\":{\"account_number\":\"05035861\",\"type\":\"account\"}},\"async\":false,\"is_document\":false,\"references\":[\"950000002\"]}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/labels")
	            .post(body)
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'POST',
	    url: 'https://sandbox-api.postmen.com/v3/labels',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"service_type":"star-track_express_courier","return_shipment":false,"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"paper_size":"default","service_options":[{"type":"pickup","start_time":"17:00:00"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"residential"}},"billing":{"paid_by":"shipper","method":{"account_number":"05035861","type":"account"}},"async":false,"is_document":false,"references":["950000002"]}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/labels';
	    $method = 'POST';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"service_type":"star-track_express_courier","return_shipment":false,"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"paper_size":"default","service_options":[{"type":"pickup","start_time":"17:00:00"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"residential"}},"billing":{"paid_by":"shipper","method":{"account_number":"05035861","type":"account"}},"async":false,"is_document":false,"references":["950000002"]}';
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
			CURLOPT_POSTFIELDS => $body
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/labels'
	
	payload = '''
	{
	  "service_type": "star-track_express_courier",
	  "return_shipment": false,
	  "shipper_account": {
	    "id": "00000000-0000-0000-0000-000000000000"
	  },
	  "paper_size": "default",
	  "service_options": [
	    {
	      "type": "pickup",
	      "start_time": "17:00:00"
	    }
	  ],
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "height": 30,
	          "width": 20,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "contact_name": "contact australia post",
	      "company_name": "A Company",
	      "email": "panda@panda.com",
	      "street1": "Sydney street",
	      "city": "MOUNTAIN GATE",
	      "postal_code": "3156",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "business",
	      "phone": "1234567890"
	    },
	    "ship_to": {
	      "contact_name": "Buckinghamshire Livingstone West",
	      "company_name": "SICAB PTY LTD",
	      "email": "panda@panda.com",
	      "street1": "Level 2, Suite 4, 55 Norton St.",
	      "city": "MOUNTAIN GATE",
	      "postal_code": "3156",
	      "state": "VIC",
	      "country": "AUS",
	      "type": "residential"
	    }
	  },
	  "billing": {
	    "paid_by": "shipper",
	    "method": {
	      "account_number": "05035861",
	      "type": "account"
	    }
	  },
	  "async": false,
	  "is_document": false,
	  "references": [
	    "950000002"
	  ]
	}
	'''
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('POST', url, data=payload, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/labels')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Post.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	request.body = '{"service_type":"star-track_express_courier","return_shipment":false,"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"paper_size":"default","service_options":[{"type":"pickup","start_time":"17:00:00"}],"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"height":30,"width":20,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"contact australia post","company_name":"A Company","email":"panda@panda.com","street1":"Sydney street","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"business","phone":"1234567890"},"ship_to":{"contact_name":"Buckinghamshire Livingstone West","company_name":"SICAB PTY LTD","email":"panda@panda.com","street1":"Level 2, Suite 4, 55 Norton St.","city":"MOUNTAIN GATE","postal_code":"3156","state":"VIC","country":"AUS","type":"residential"}},"billing":{"paid_by":"shipper","method":{"account_number":"05035861","type":"account"}},"async":false,"is_document":false,"references":["950000002"]}'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
id string Label ID
status string Accepts: creating,created,cancelling,cancelled,manifesting,manifested,failed.
ship_date string Ship Date in YYYY-MM-DD
tracking_numbers array of strings
files a files object A files object
rate rate type The amount of a charge or payment with reference to some basis of calculation.
created_at string A formatted date.
updated_at string A formatted date.
references array of strings Reference numbers for a label
shipper_account object account of shipper
service_type string Service Types Accepts: star-track_afternoon_2u2day,star-track_cold_chain,star-track_express,star-track_express_courier,star-track_express_half_van,star-track_express_van,star-track_express_wagon,star-track_fixed_price_premium,star-track_immediate_priority_courier,star-track_immediate_priority_half_van,star-track_immediate_priority_van,star-track_immediate_priority_wagon,star-track_on_demand_now,star-track_on_demand_saturday,star-track_on_demand_tonight,star-track_premium,star-track_same_day_2u2day,star-track_saturday_2u2day,star-track_standard_courier,star-track_standard_half_van,star-track_standard_van,star-track_standard_wagon,star-track_twilight_2u2day.

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "3137d2de-3e15-5169-87f7-d6310282e410",
	    "status": "created",
	    "ship_date": "2019-07-11",
	    "created_at": "2019-07-11T03:05:12+00:00",
	    "updated_at": "2019-07-11T03:05:33+00:00",
	    "tracking_numbers": [
	      "EXC0020023440942001312361"
	    ],
	    "files": {
	      "label": {
	        "paper_size": "a4",
	        "url": "https://sandbox-download.postmen.com/label/2019-07-11/53a0e132-5aed-41c0-8205-69522f385ea2-1562814330123544.pdf",
	        "file_type": "pdf"
	      },
	      "invoice": null,
	      "customs_declaration": null,
	      "manifest": null
	    },
	    "rate": {
	      "shipper_account": {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "slug": "star-track",
	        "description": "star-track"
	      },
	      "service_type": "star-track_express_courier",
	      "service_name": "Express Courier",
	      "pickup_deadline": null,
	      "booking_cut_off": null,
	      "delivery_date": null,
	      "transit_time": null,
	      "error_message": null,
	      "info_message": null,
	      "charge_weight": null,
	      "total_charge": {
	        "amount": 0,
	        "currency": "AUD"
	      },
	      "detailed_charges": []
	    },
	    "references": [
	      "950000002"
	    ],
	    "service_type": "star-track_express_courier",
	    "shipper_account": {
	      "id": "a023380a-113e-12234-oda1-b2031e1dd21f",
	      "slug": "star-track"
	    }
	  }
	}

GET Retrieve a label

Try it 
/labels/:id

Retrieve a label


	{}
	

	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/labels/ \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/labels/");
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "GET";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/labels/")
	            .get()
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'GET',
	    url: 'https://sandbox-api.postmen.com/v3/labels/',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		}
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/labels/';
	    $method = 'GET';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/labels/'
	
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('GET', url, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/labels/')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Get.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
id string Label ID
status string Accepts: creating,created,cancelling,cancelled,manifesting,manifested,failed.
ship_date string Ship Date in YYYY-MM-DD
tracking_numbers array of strings
files a files object A files object
rate rate type The amount of a charge or payment with reference to some basis of calculation.
created_at string A formatted date.
updated_at string A formatted date.

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "3537d0de-3b99-4969-87f7-d8310082e490",
	    "status": "manifested",
	    "ship_date": "2019-07-11",
	    "created_at": "2019-07-11T03:05:12+00:00",
	    "updated_at": "2019-07-11T03:05:54+00:00",
	    "tracking_numbers": [
	      "EXC001002940500131561"
	    ],
	    "files": {
	      "label": {
	        "paper_size": "a4",
	        "url": "https://sandbox-download.postmen.com/label/2019-07-11/53a0e132-5aed-41c0-8205-69522f385ea2-1562814330123544.pdf",
	        "file_type": "pdf"
	      },
	      "invoice": null,
	      "customs_declaration": null,
	      "manifest": null
	    },
	    "rate": {
	      "shipper_account": {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "slug": "star-track",
	        "description": "star-track"
	      },
	      "service_type": "star-track_express_courier",
	      "service_name": "Express Courier",
	      "pickup_deadline": null,
	      "booking_cut_off": null,
	      "delivery_date": null,
	      "transit_time": null,
	      "error_message": null,
	      "info_message": null,
	      "charge_weight": null,
	      "total_charge": {
	        "amount": 0,
	        "currency": "AUD"
	      },
	      "detailed_charges": []
	    },
	    "references": [
	      "950000002"
	    ],
	    "service_type": "star-track_express_courier",
	    "shipper_account": {
	      "id": "00000000-0000-0000-0000-000000000000",
	      "slug": "star-track"
	    }
	  }
	}

GET List all labels

Try it 
/labels

List all labels

NameTypeDescription
shipper_account_id string Shipper account ID
status string Label status Accepts: creating,created,cancelling,cancelled,manifesting,manifested,failed.
limit string Number of records per page
created_at_min string Start date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: 24hrs ago)
created_at_max string End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: NOW())
tracking_numbers string Tracking numbers (separated by comma)
s string Partial search of tracking_number or reference
next_token string Next token

	{}
	

	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/labels \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/labels");
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "GET";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/labels")
	            .get()
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'GET',
	    url: 'https://sandbox-api.postmen.com/v3/labels',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		}
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/labels';
	    $method = 'GET';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/labels'
	
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('GET', url, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/labels')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Get.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
next_token string or null Any of string or null
limit number Number of records per page
labels array of a label object A label object

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "next_token": null,
	    "limit": 10,
	    "created_at_min": "2019-07-10T06:24:55+00:00",
	    "created_at_max": "2019-07-11T06:24:55+00:00",
	    "labels": [
	      {
	        "id": "3537d0de-3b99-4969-87f7-d8310082e490",
	        "status": "manifested",
	        "ship_date": "2019-07-11",
	        "created_at": "2019-07-11T03:05:12+00:00",
	        "updated_at": "2019-07-11T03:05:54+00:00",
	        "tracking_numbers": [
	          "EXC001102740601131561"
	        ],
	        "files": {
	          "label": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/label/2019-07-11/53a0e132-5aed-41c0-8205-69522f385ea2-1562814330123544.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": null,
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "rate": {
	          "shipper_account": {
	            "id": "00000000-0000-0000-0000-000000000000",
	            "slug": "star-track",
	            "description": "star-track"
	          },
	          "service_type": "star-track_express_courier",
	          "service_name": "Express Courier",
	          "pickup_deadline": null,
	          "booking_cut_off": null,
	          "delivery_date": null,
	          "transit_time": null,
	          "error_message": null,
	          "info_message": null,
	          "charge_weight": null,
	          "total_charge": {
	            "amount": 0,
	            "currency": "AUD"
	          },
	          "detailed_charges": []
	        },
	        "references": [
	          "950000002"
	        ],
	        "service_type": "star-track_express_courier",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track"
	        }
	      },
	      {
	        "id": "7f9c4514-d0bd-4e9a-ad78-783246901c01",
	        "status": "manifested",
	        "ship_date": "2019-07-10",
	        "created_at": "2019-07-10T11:17:30+00:00",
	        "updated_at": "2019-07-10T11:24:47+00:00",
	        "tracking_numbers": [
	          "EXC001102140601131561"
	        ],
	        "files": {
	          "label": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/label/2019-07-11/4b72ecc8-2ecd-4e8f-b88b-3a6fc04ff1a5-1562757460569646.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": null,
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "rate": {
	          "shipper_account": {
	            "id": "00000000-0000-0000-0000-000000000000",
	            "slug": "star-track",
	            "description": "star-track"
	          },
	          "service_type": "star-track_express_courier",
	          "service_name": "Express Courier",
	          "pickup_deadline": null,
	          "booking_cut_off": null,
	          "delivery_date": null,
	          "transit_time": null,
	          "error_message": null,
	          "info_message": null,
	          "charge_weight": null,
	          "total_charge": {
	            "amount": 0,
	            "currency": "AUD"
	          },
	          "detailed_charges": []
	        },
	        "references": [
	          "950000002"
	        ],
	        "service_type": "star-track_express_courier",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track"
	        }
	      },
	      {
	        "id": "b6e5e329-b10a-4758-be68-680a4c096df0",
	        "status": "failed",
	        "ship_date": null,
	        "created_at": "2019-07-10T11:17:15+00:00",
	        "updated_at": "2019-07-10T11:17:18+00:00",
	        "tracking_numbers": [],
	        "files": null,
	        "rate": null,
	        "references": [
	          "950000002"
	        ],
	        "service_type": "star-track_express_courier",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track"
	        }
	      },
	      {
	        "id": "8ed30151-1a56-4940-94e9-7803ba87fd62",
	        "status": "failed",
	        "ship_date": null,
	        "created_at": "2019-07-10T10:39:59+00:00",
	        "updated_at": "2019-07-10T10:40:01+00:00",
	        "tracking_numbers": [],
	        "files": null,
	        "rate": null,
	        "references": [
	          "950000002"
	        ],
	        "service_type": "star-track_express_courier",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track"
	        }
	      },
	      {
	        "id": "cea993dd-e6e9-4400-a057-6984529f12ae",
	        "status": "failed",
	        "ship_date": null,
	        "created_at": "2019-07-10T10:38:39+00:00",
	        "updated_at": "2019-07-10T10:38:43+00:00",
	        "tracking_numbers": [],
	        "files": null,
	        "rate": null,
	        "references": [
	          "950000002"
	        ],
	        "service_type": "star-track_express_courier",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track"
	        }
	      },
	      {
	        "id": "1e447ffd-d5b7-48d7-a208-150f9aea8ee3",
	        "status": "failed",
	        "ship_date": null,
	        "created_at": "2019-07-10T09:31:32+00:00",
	        "updated_at": "2019-07-10T09:31:44+00:00",
	        "tracking_numbers": [],
	        "files": null,
	        "rate": null,
	        "references": [
	          "950000002"
	        ],
	        "service_type": "star-track_express_courier",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track"
	        }
	      },
	      {
	        "id": "f5c1ca4c-f04f-4f89-88e2-b2fed11cc0f3",
	        "status": "failed",
	        "ship_date": null,
	        "created_at": "2019-07-10T09:11:22+00:00",
	        "updated_at": "2019-07-10T09:11:32+00:00",
	        "tracking_numbers": [],
	        "files": null,
	        "rate": null,
	        "references": [
	          "950000002"
	        ],
	        "service_type": "star-track_express_courier",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track"
	        }
	      },
	      {
	        "id": "e833d1b2-5fa5-4ee0-b60b-962bee727ef5",
	        "status": "manifested",
	        "ship_date": "2019-07-11",
	        "created_at": "2019-07-10T07:19:26+00:00",
	        "updated_at": "2019-07-10T08:09:09+00:00",
	        "tracking_numbers": [
	          "EXC001002732420439569"
	        ],
	        "files": {
	          "label": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/label/2019-07-11/205d989c-a59b-4b87-9f2c-8982fb57c42c-1562743178646208.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": null,
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "rate": {
	          "shipper_account": {
	            "id": "00000000-0000-0000-0000-000000000000",
	            "slug": "star-track",
	            "description": "star-track"
	          },
	          "service_type": "star-track_express_courier",
	          "service_name": "Express Courier",
	          "pickup_deadline": null,
	          "booking_cut_off": null,
	          "delivery_date": null,
	          "transit_time": null,
	          "error_message": null,
	          "info_message": null,
	          "charge_weight": null,
	          "total_charge": {
	            "amount": 0,
	            "currency": "AUD"
	          },
	          "detailed_charges": []
	        },
	        "references": [
	          "950000002"
	        ],
	        "service_type": "star-track_express_courier",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track"
	        }
	      },
	      {
	        "id": "fd7cbdae-5a80-44b5-b4f3-4de7e2accbd9",
	        "status": "manifested",
	        "ship_date": "2019-07-11",
	        "created_at": "2019-07-10T07:13:11+00:00",
	        "updated_at": "2019-07-10T08:09:09+00:00",
	        "tracking_numbers": [
	          "EXC001002752300181151"
	        ],
	        "files": {
	          "label": {
	            "paper_size": "a4",
	            "url": "s3://test/redbull/postmen.worker/_s3_bucket/label__2019-07-10__fd7cbdae-5a80-44b5-b4f3-4de7e2accbd9.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": null,
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "rate": {
	          "shipper_account": {
	            "id": "00000000-0000-0000-0000-000000000000",
	            "slug": "star-track",
	            "description": "star-track"
	          },
	          "service_type": "star-track_express_courier",
	          "service_name": "Express Courier",
	          "pickup_deadline": null,
	          "booking_cut_off": null,
	          "delivery_date": null,
	          "transit_time": null,
	          "error_message": null,
	          "info_message": null,
	          "charge_weight": null,
	          "total_charge": {
	            "amount": 0,
	            "currency": "AUD"
	          },
	          "detailed_charges": []
	        },
	        "references": [
	          "950000002"
	        ],
	        "service_type": "star-track_express_courier",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track"
	        }
	      }
	    ]
	  }
	}

Manifests

Manifests

POST Create a manifest

Try it 
/manifests

Create a manifest

NameTypeDescription
shipper_account * reference Object reference
async boolean enable async mode or not (set to false if not provided)
label_ids array of strings An array of label ids to create a manifest, only available for USPS / Australia Post / StarTrack, will throw error if any label_id does not belong to this shipper_account or cannot be manifested.

	{
	  "shipper_account": {
	    "id": "00000000-0000-0000-0000-000000000000"
	  },
	  "label_ids": [
	    "23d3ced-2md2-5245-87f7-d1313082e290"
	  ]
	}
	

	curl --request POST \
	    --url https://sandbox-api.postmen.com/v3/manifests \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"label_ids":["23d3ced-2md2-5245-87f7-d1313082e290"]}'
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/manifests");
	        string json = "{\"shipper_account\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"label_ids\":[\"23d3ced-2md2-5245-87f7-d1313082e290\"]}";
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "POST";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        using (StreamWriter streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
	        {
	            streamWriter.Write(json);
	            streamWriter.Flush();
	            streamWriter.Close();
	        }
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	        RequestBody body = RequestBody.create(mediaType, "{\"shipper_account\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"label_ids\":[\"23d3ced-2md2-5245-87f7-d1313082e290\"]}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/manifests")
	            .post(body)
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'POST',
	    url: 'https://sandbox-api.postmen.com/v3/manifests',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"label_ids":["23d3ced-2md2-5245-87f7-d1313082e290"]}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/manifests';
	    $method = 'POST';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"label_ids":["23d3ced-2md2-5245-87f7-d1313082e290"]}';
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
			CURLOPT_POSTFIELDS => $body
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/manifests'
	
	payload = '''
	{
	  "shipper_account": {
	    "id": "00000000-0000-0000-0000-000000000000"
	  },
	  "label_ids": [
	    "23d3ced-2md2-5245-87f7-d1313082e290"
	  ]
	}
	'''
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('POST', url, data=payload, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/manifests')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Post.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	request.body = '{"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"label_ids":["23d3ced-2md2-5245-87f7-d1313082e290"]}'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
id string Manifest ID
status string Accepts: manifesting,manifested,failed.
shipper_account shipper account information Shipper Account (brief information for rate and manifest responses)
labels array of a manifesting label object A manifesting label object
files a files object A files object
created_at string A formatted date.
updated_at string A formatted date.

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "224233a4-fb05-43ab-9692-aeb1c9305b94",
	    "status": "manifested",
	    "shipper_account": {
	      "id": "b04a380a-401e-26c0-825d-b4051e1dd31f",
	      "slug": "star-track",
	      "description": "star-track"
	    },
	    "created_at": "2019-07-11T03:05:46+00:00",
	    "updated_at": "2019-07-11T03:05:54+00:00",
	    "labels": [
	      {
	        "id": "23d3ced-2md2-5245-87f7-d1313082e290",
	        "manifested": true
	      }
	    ],
	    "files": {
	      "label": null,
	      "invoice": null,
	      "customs_declaration": null,
	      "manifest": {
	        "paper_size": "a4",
	        "url": "https://sandbox-download.postmen.com/manifest/2019-07-11/222454-fb05-43ab-9692-a2dk202-1349838294.pdf",
	        "file_type": "pdf"
	      }
	    }
	  }
	}

GET List all manifests

Try it 
/manifests

List all manifests

NameTypeDescription
shipper_account_id string Shipper account ID
status string Manifest status Accepts: manifesting,manifested,failed.
limit string Number of records per page
created_at_min string Start date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: 24hrs ago)
created_at_max string End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: NOW())
next_token string Next token

	{}
	

	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/manifests \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/manifests");
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "GET";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/manifests")
	            .get()
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'GET',
	    url: 'https://sandbox-api.postmen.com/v3/manifests',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		}
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/manifests';
	    $method = 'GET';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/manifests'
	
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('GET', url, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/manifests')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Get.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
next_token string or null Any of string or null
limit number Number of records per page
manifests array of a manifest object A manifest object

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "next_token": "",
	    "limit": 20,
	    "created_at_min": "2019-07-10T06:40:27+00:00",
	    "created_at_max": "2019-07-11T06:40:27+00:00",
	    "manifests": [
	      {
	        "id": "224233a4-fb05-43ab-9692-aeb1c9305b94",
	        "status": "manifested",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track",
	          "description": "star-track"
	        },
	        "created_at": "2019-07-11T03:05:46+00:00",
	        "updated_at": "2019-07-11T03:05:54+00:00",
	        "labels": [
	          {
	            "id": "3537d0de-3b99-4969-87f7-d8310082e490",
	            "manifested": true
	          }
	        ],
	        "files": {
	          "label": null,
	          "invoice": null,
	          "customs_declaration": null,
	          "manifest": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/manifest/2019-07-11/224233a4-fb05-43ab-9692-aeb1c9305b94-1562814353704873.pdf",
	            "file_type": "pdf"
	          }
	        }
	      },
	      {
	        "id": "02cbbe92-af02-4e58-860f-0ed7e8283e5f",
	        "status": "manifested",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track",
	          "description": "star-track"
	        },
	        "created_at": "2019-07-10T11:24:37+00:00",
	        "updated_at": "2019-07-10T11:24:47+00:00",
	        "labels": [
	          {
	            "id": "7f9c4514-d0bd-4e9a-ad78-783246901c01",
	            "manifested": true
	          }
	        ],
	        "files": {
	          "label": null,
	          "invoice": null,
	          "customs_declaration": null,
	          "manifest": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/manifest/2019-07-10/02cbbe92-af02-4e58-860f-0ed7e8283e5f-1562757886868632.pdf",
	            "file_type": "pdf"
	          }
	        }
	      },
	      {
	        "id": "a38114b1-7991-4a65-bb8a-667fb0c7a0b3",
	        "status": "manifested",
	        "shipper_account": {
	          "id": "00000000-0000-0000-0000-000000000000",
	          "slug": "star-track",
	          "description": "star-track"
	        },
	        "created_at": "2019-07-10T08:06:16+00:00",
	        "updated_at": "2019-07-10T08:09:08+00:00",
	        "labels": [
	          {
	            "id": "fd7cbdae-5a80-44b5-b4f3-4de7e2accbd9",
	            "manifested": true
	          },
	          {
	            "id": "e833d1b2-5fa5-4ee0-b60b-962bee727ef5",
	            "manifested": true
	          }
	        ],
	        "files": {
	          "label": null,
	          "invoice": null,
	          "customs_declaration": null,
	          "manifest": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/manifest/2019-07-10/a38114b1-7991-4a65-bb8a-667fb0c7a0b3-1562746144520072.pdf",
	            "file_type": "pdf"
	          }
	        }
	      }
	    ]
	  }
	}

GET Retrieve a manifest

Try it 
/manifests/:id

Retrieve a manifest


	{}
	

	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/manifests/ \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/manifests/");
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "GET";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/manifests/")
	            .get()
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'GET',
	    url: 'https://sandbox-api.postmen.com/v3/manifests/',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		}
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/manifests/';
	    $method = 'GET';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/manifests/'
	
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('GET', url, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/manifests/')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Get.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
id string Manifest ID
status string Accepts: manifesting,manifested,failed.
shipper_account shipper account information Shipper Account (brief information for rate and manifest responses)
labels array of a manifesting label object A manifesting label object
files a files object A files object
created_at string A formatted date.
updated_at string A formatted date.

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "224233a4-fb05-43ab-9692-aeb1c9305b94",
	    "status": "manifested",
	    "shipper_account": {
	      "id": "00000000-0000-0000-0000-000000000000",
	      "slug": "star-track",
	      "description": "star-track"
	    },
	    "created_at": "2019-07-11T03:05:46+00:00",
	    "updated_at": "2019-07-11T03:05:54+00:00",
	    "labels": [
	      {
	        "id": "3537d0de-3b99-4969-87f7-d8310082e490",
	        "manifested": true
	      }
	    ],
	    "files": {
	      "label": null,
	      "invoice": null,
	      "customs_declaration": null,
	      "manifest": {
	        "paper_size": "a4",
	        "url": "https://sandbox-download.postmen.com/manifest/2019-07-11/224233a4-fb05-43ab-9692-aeb1c9305b94-1562814353704873.pdf",
	        "file_type": "pdf"
	      }
	    }
	  }
	}

Cancel Labels

Cancel Labels

POST Cancel a label

Try it 
/cancel-labels

Cancel a label

NameTypeDescription
label * reference Object reference
async boolean enable async mode or not (set to false if not provided)

	{}
	

	curl --request POST \
	    --url https://sandbox-api.postmen.com/v3/cancel-labels \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/cancel-labels");
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "POST";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/cancel-labels")
	            .post()
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'POST',
	    url: 'https://sandbox-api.postmen.com/v3/cancel-labels',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		}
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/cancel-labels';
	    $method = 'POST';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/cancel-labels'
	
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('POST', url, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/cancel-labels')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Post.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
id string Cancel Label ID
status string Accepts: cancelling,cancelled,failed.
refund_status string Accepts: requested.
label reference Object reference
created_at string A formatted date.
updated_at string A formatted date.

Response example

No example available

GET List all cancel labels

Try it 
/cancel-labels

List all cancel labels

NameTypeDescription
shipper_account_id string Shipper account ID
status string Cancel Label status Accepts: cancelling,cancelled,failed.
limit string Number of records per page
created_at_min string Start date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: 24hrs ago)
created_at_max string End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: NOW())
next_token string Next token

	{}
	

	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/cancel-labels \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/cancel-labels");
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "GET";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/cancel-labels")
	            .get()
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'GET',
	    url: 'https://sandbox-api.postmen.com/v3/cancel-labels',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		}
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/cancel-labels';
	    $method = 'GET';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/cancel-labels'
	
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('GET', url, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/cancel-labels')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Get.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
next_token string or null Any of string or null
limit number Number of records per page
cancel_labels array of a cancel label object A cancel label object

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "next_token": "eyJjcmVhdGVkX2F0IjoiMjAxNS0000000000Njo1MjozNC4zNjFaIiwiaWQiOiIwNGZlNDgz0000000000QxYzItYWUxOC1kNTEzZjNmMWNmMWEiLCJ1c2Vy0000000000RjNDY4NTAtNjIyNS00ZTBiLTg5ZTQtZTM3N2M3YWM5ZDk4In0=",
	    "limit": 20,
	    "created_at_min": "2015-11-26T08:58:59+00:00",
	    "created_at_max": "2015-11-27T08:58:59+00:00",
	    "cancel-labels": [
	      {
	        "id": "0e37b87a-684e-43cd-aaba-f0718e066519",
	        "status": "cancelled",
	        "label": {
	          "id": "166218cd-3e0a-4753-ac26-89ddabcd1dda"
	        },
	        "created_at": "2015-11-27T08:55:13+00:00",
	        "updated_at": "2015-11-27T08:55:14+00:00"
	      },
	      {
	        "id": "d05971fb-fddf-4243-ad58-7f34401b1da9",
	        "status": "cancelled",
	        "label": {
	          "id": "0426d03a-ae0d-4818-801c-4e92b31450da"
	        },
	        "created_at": "2015-11-27T08:52:35+00:00",
	        "updated_at": "2015-11-27T08:52:37+00:00"
	      },
	      {
	        "id": "cb404620-890b-4d37-9692-34ea08c4f111",
	        "status": "cancelled",
	        "label": {
	          "id": "df5769b0-60d0-4daf-8bad-bd164d64e12b"
	        },
	        "created_at": "2015-11-27T08:52:08+00:00",
	        "updated_at": "2015-11-27T08:52:09+00:00"
	      },
	      {
	        "id": "5472583e-3e55-492f-b1ab-5208de524e4e",
	        "status": "cancelled",
	        "label": {
	          "id": "72393fe3-be8e-4a7a-8434-1f0b5b56c09e"
	        },
	        "created_at": "2015-11-27T08:47:01+00:00",
	        "updated_at": "2015-11-27T08:47:02+00:00"
	      },
	      {
	        "id": "d4811447-fa1b-42a9-9820-09dfd57ed8e0",
	        "status": "cancelled",
	        "label": null,
	        "created_at": "2015-11-27T08:41:05+00:00",
	        "updated_at": "2015-11-27T08:41:05+00:00"
	      },
	      {
	        "id": "28e02aea-cd0c-4553-8a63-52bc98c29420",
	        "status": "cancelled",
	        "label": {
	          "id": "b3d75a21-9d27-4b1b-9592-485667f59e3f"
	        },
	        "created_at": "2015-11-27T08:25:12+00:00",
	        "updated_at": "2015-11-27T08:25:13+00:00"
	      },
	      {
	        "id": "39b4be71-f3d8-4d33-be15-fbf7be0b41d0",
	        "status": "cancelled",
	        "label": {
	          "id": "d88e9447-c84e-4e97-8d1f-ba98038a7a9e"
	        },
	        "created_at": "2015-11-27T08:22:35+00:00",
	        "updated_at": "2015-11-27T08:22:37+00:00"
	      },
	      {
	        "id": "6941fcfa-6e14-406c-9e9f-4a6f4fb550c1",
	        "status": "cancelled",
	        "label": {
	          "id": "2d4caaf4-1231-412d-bb94-62bae88ba785"
	        },
	        "created_at": "2015-11-27T08:22:09+00:00",
	        "updated_at": "2015-11-27T08:22:09+00:00"
	      },
	      {
	        "id": "263123da-c0c0-4fd1-bf1d-3936a788d272",
	        "status": "cancelled",
	        "label": {
	          "id": "9fc1f61b-7542-4015-a3dd-5dc4d4e8689b"
	        },
	        "created_at": "2015-11-27T08:17:00+00:00",
	        "updated_at": "2015-11-27T08:17:01+00:00"
	      },
	      {
	        "id": "38b34575-2081-4333-8779-78cab4d9a642",
	        "status": "cancelled",
	        "label": null,
	        "created_at": "2015-11-27T08:11:04+00:00",
	        "updated_at": "2015-11-27T08:11:04+00:00"
	      },
	      {
	        "id": "2944f236-6420-4f9f-8c20-b06daaf39f39",
	        "status": "cancelled",
	        "label": {
	          "id": "b05b2f29-9ed1-4844-90f6-a1ff13af56bb"
	        },
	        "created_at": "2015-11-27T07:55:12+00:00",
	        "updated_at": "2015-11-27T07:55:13+00:00"
	      },
	      {
	        "id": "0c074025-c4d9-47ce-bb89-ae854abe1a1b",
	        "status": "cancelled",
	        "label": {
	          "id": "04b151b1-deb1-41e8-afbe-726df8a7ff54"
	        },
	        "created_at": "2015-11-27T07:52:37+00:00",
	        "updated_at": "2015-11-27T07:52:38+00:00"
	      },
	      {
	        "id": "7c78c2a8-0ff0-4c80-bb99-9ae9037034e4",
	        "status": "cancelled",
	        "label": {
	          "id": "2afe41d0-70fe-4130-8e76-8d305e1f15dc"
	        },
	        "created_at": "2015-11-27T07:47:02+00:00",
	        "updated_at": "2015-11-27T07:47:02+00:00"
	      },
	      {
	        "id": "a0dd6cd0-00c6-4502-ba45-73369a010ca7",
	        "status": "cancelled",
	        "label": null,
	        "created_at": "2015-11-27T07:41:04+00:00",
	        "updated_at": "2015-11-27T07:41:04+00:00"
	      },
	      {
	        "id": "78e50de5-f5e9-455c-922d-2de14fe91952",
	        "status": "cancelled",
	        "label": {
	          "id": "b09f1969-e77f-42dc-94d0-32fe5d4b3337"
	        },
	        "created_at": "2015-11-27T07:25:13+00:00",
	        "updated_at": "2015-11-27T07:25:14+00:00"
	      },
	      {
	        "id": "a4a13f7a-66b1-410c-824c-b9edf9aada3a",
	        "status": "cancelled",
	        "label": {
	          "id": "9f783f53-c336-4de7-ad6d-b617614ba269"
	        },
	        "created_at": "2015-11-27T07:22:35+00:00",
	        "updated_at": "2015-11-27T07:22:36+00:00"
	      },
	      {
	        "id": "f3a97cbe-8792-478c-bfc2-7ab9be026760",
	        "status": "cancelled",
	        "label": {
	          "id": "7350085b-a11c-4b63-874e-15a542ee73d2"
	        },
	        "created_at": "2015-11-27T07:17:00+00:00",
	        "updated_at": "2015-11-27T07:17:00+00:00"
	      },
	      {
	        "id": "0f3f06c6-b52d-4fcb-a6a9-7f606991d79c",
	        "status": "cancelled",
	        "label": null,
	        "created_at": "2015-11-27T07:11:04+00:00",
	        "updated_at": "2015-11-27T07:11:04+00:00"
	      },
	      {
	        "id": "371186a1-67f3-434c-af79-18ce78ece73e",
	        "status": "cancelled",
	        "label": {
	          "id": "1e0af41f-e3d8-42ce-958c-117ebb72ebc5"
	        },
	        "created_at": "2015-11-27T06:55:13+00:00",
	        "updated_at": "2015-11-27T06:55:13+00:00"
	      },
	      {
	        "id": "04fe4835-8527-41c2-ae18-d513f3f1cf1a",
	        "status": "cancelled",
	        "label": {
	          "id": "f6a3d017-dd7f-42b9-abeb-c8104c130e0a"
	        },
	        "created_at": "2015-11-27T06:52:34+00:00",
	        "updated_at": "2015-11-27T06:52:35+00:00"
	      }
	    ]
	  }
	}

GET Retrieve a cancel label

Try it 
/cancel-labels/:id

Retrieve a cancel label


	{
	  "async": false,
	  "label": {
	    "id": "024bca95-8ab6-42ef-8f48-4b897c1e9eea"
	  }
	}
	

	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/cancel-labels/ \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"async":false,"label":{"id":"024bca95-8ab6-42ef-8f48-4b897c1e9eea"}}'
	

	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/cancel-labels/");
	        string json = "{\"async\":false,\"label\":{\"id\":\"024bca95-8ab6-42ef-8f48-4b897c1e9eea\"}}";
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "GET";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        using (StreamWriter streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
	        {
	            streamWriter.Write(json);
	            streamWriter.Flush();
	            streamWriter.Close();
	        }
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}
	

	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	        RequestBody body = RequestBody.create(mediaType, "{\"async\":false,\"label\":{\"id\":\"024bca95-8ab6-42ef-8f48-4b897c1e9eea\"}}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/cancel-labels/")
	            .get(body)
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}
	
var request = require("request");
	var options = {
		method: 'GET',
	    url: 'https://sandbox-api.postmen.com/v3/cancel-labels/',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"async":false,"label":{"id":"024bca95-8ab6-42ef-8f48-4b897c1e9eea"}}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});

	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/cancel-labels/';
	    $method = 'GET';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"async":false,"label":{"id":"024bca95-8ab6-42ef-8f48-4b897c1e9eea"}}';
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
			CURLOPT_POSTFIELDS => $body
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>
	

	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/cancel-labels/'
	
	payload = '''
	{
	  "async": false,
	  "label": {
	    "id": "024bca95-8ab6-42ef-8f48-4b897c1e9eea"
	  }
	}
	'''
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('GET', url, data=payload, headers=headers)
	
	print(response.text)
	

	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/cancel-labels/')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Get.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	request.body = '{"async":false,"label":{"id":"024bca95-8ab6-42ef-8f48-4b897c1e9eea"}}'
	
	response = http.request(request)
	puts response.read_body
NameTypeDescription
id string Label ID
status string Accepts: cancelling,cancelled,failed.
label reference Object reference
created_at string A formatted date.
updated_at string A formatted date.

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "34639789-fb21-40d0-a2dd-3e28b7277527",
	    "status": "cancelled",
	    "created_at": "2019-07-11T07:13:06+00:00",
	    "updated_at": "2019-07-11T07:13:12+00:00",
	    "label": {
	      "id": "024bca95-8ab6-42ef-8f48-4b897c1e9eea"
	    }
	  }
	}

Shipper Accounts

Shipper Accounts

POST Create a shipper account

Try it 
/shipper-accounts

Create a shipper account

NameTypeDescription
slug string Courier Slug Accepts: star-track.
description string The description of the account
address address - shipper account Address object
timezone string Use IANA — Time Zone Database Accepts: Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Asmara,Africa/Asmera,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/El_Aaiun,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Timbuktu,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anchorage,America/Anguilla,America/Antigua,America/Araguaina,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/ComodRivadavia,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/La_Rioja,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Argentina/Ushuaia,America/Aruba,America/Asuncion,America/Atikokan,America/Atka,America/Bahia,America/Bahia_Banderas,America/Barbados,America/Belem,America/Belize,America/Blanc-Sablon,America/Boa_Vista,America/Bogota,America/Boise,America/Buenos_Aires,America/Cambridge_Bay,America/Campo_Grande,America/Cancun,America/Caracas,America/Catamarca,America/Cayenne,America/Cayman,America/Chicago,America/Chihuahua,America/Coral_Harbour,America/Cordoba,America/Costa_Rica,America/Creston,America/Cuiaba,America/Curacao,America/Danmarkshavn,America/Dawson,America/Dawson_Creek,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/Eirunepe,America/El_Salvador,America/Ensenada,America/Fort_Nelson,America/Fort_Wayne,America/Fortaleza,America/Glace_Bay,America/Godthab,America/Goose_Bay,America/Grand_Turk,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Knox,America/Indiana/Marengo,America/Indiana/Petersburg,America/Indiana/Tell_City,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indiana/Winamac,America/Indianapolis,America/Inuvik,America/Iqaluit,America/Jamaica,America/Jujuy,America/Juneau,America/Kentucky/Louisville,America/Kentucky/Monticello,America/Knox_IN,America/Kralendijk,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Lower_Princes,America/Maceio,America/Managua,America/Manaus,America/Marigot,America/Martinique,America/Matamoros,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Metlakatla,America/Mexico_City,America/Miquelon,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Montserrat,America/Nassau,America/New_York,America/Nipigon,America/Nome,America/Noronha,America/North_Dakota/Beulah,America/North_Dakota/Center,America/North_Dakota/New_Salem,America/Ojinaga,America/Panama,America/Pangnirtung,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Port_of_Spain,America/Porto_Acre,America/Porto_Velho,America/Puerto_Rico,America/Punta_Arenas,America/Rainy_River,America/Rankin_Inlet,America/Recife,America/Regina,America/Resolute,America/Rio_Branco,America/Rosario,America/Santa_Isabel,America/Santarem,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/Shiprock,America/Sitka,America/St_Barthelemy,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/St_Vincent,America/Swift_Current,America/Tegucigalpa,America/Thule,America/Thunder_Bay,America/Tijuana,America/Toronto,America/Tortola,America/Vancouver,America/Virgin,America/Whitehorse,America/Winnipeg,America/Yakutat,America/Yellowknife,Antarctica/Casey,Antarctica/Davis,Antarctica/DumontDUrville,Antarctica/Macquarie,Antarctica/Mawson,Antarctica/McMurdo,Antarctica/Palmer,Antarctica/Rothera,Antarctica/South_Pole,Antarctica/Syowa,Antarctica/Troll,Antarctica/Vostok,Arctic/Longyearbyen,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Anadyr,Asia/Aqtau,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Atyrau,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Barnaul,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Choibalsan,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dili,Asia/Dubai,Asia/Dushanbe,Asia/Famagusta,Asia/Gaza,Asia/Harbin,Asia/Hebron,Asia/Ho_Chi_Minh,Asia/Hong_Kong,Asia/Hovd,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Kamchatka,Asia/Karachi,Asia/Kashgar,Asia/Kathmandu,Asia/Katmandu,Asia/Khandyga,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Magadan,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pontianak,Asia/Pyongyang,Asia/Qatar,Asia/Qyzylorda,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Srednekolymsk,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimbu,Asia/Thimphu,Asia/Tokyo,Asia/Tomsk,Asia/Ujung_Pandang,Asia/Ulaanbaatar,Asia/Ulan_Bator,Asia/Urumqi,Asia/Ust-Nera,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yangon,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Jan_Mayen,Atlantic/Madeira,Atlantic/Reykjavik,Atlantic/South_Georgia,Atlantic/St_Helena,Atlantic/Stanley,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Broken_Hill,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Eucla,Australia/Hobart,Australia/LHI,Australia/Lindeman,Australia/Lord_Howe,Australia/Melbourne,Australia/NSW,Australia/North,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Australia/Yancowinna,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/East-Saskatchewan,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,Canada/Saskatchewan,Canada/Yukon,Chile/Continental,Chile/EasterIsland,Europe/Amsterdam,Europe/Andorra,Europe/Astrakhan,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Busingen,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Guernsey,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Jersey,Europe/Kaliningrad,Europe/Kiev,Europe/Kirov,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Mariehamn,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Saratov,Europe/Simferopol,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Ulyanovsk,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,Indian/Antananarivo,Indian/Chagos,Indian/Christmas,Indian/Cocos,Indian/Comoro,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Mayotte,Indian/Reunion,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,Pacific/Apia,Pacific/Auckland,Pacific/Bougainville,Pacific/Chatham,Pacific/Chuuk,Pacific/Easter,Pacific/Efate,Pacific/Enderbury,Pacific/Fakaofo,Pacific/Fiji,Pacific/Funafuti,Pacific/Galapagos,Pacific/Gambier,Pacific/Guadalcanal,Pacific/Guam,Pacific/Honolulu,Pacific/Johnston,Pacific/Kiritimati,Pacific/Kosrae,Pacific/Kwajalein,Pacific/Majuro,Pacific/Marquesas,Pacific/Midway,Pacific/Nauru,Pacific/Niue,Pacific/Norfolk,Pacific/Noumea,Pacific/Pago_Pago,Pacific/Palau,Pacific/Pitcairn,Pacific/Pohnpei,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Rarotonga,Pacific/Saipan,Pacific/Samoa,Pacific/Tahiti,Pacific/Tarawa,Pacific/Tongatapu,Pacific/Truk,Pacific/Wake,Pacific/Wallis,Pacific/Yap,US/Alaska,US/Aleutian,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,US/Samoa,UTC.
credentials shipper account credentials Shipper Account Credentials
settings shipper account settings Shipper Account Settings
NameTypeDescription
id string Shipper Account ID
address address - shipper account Address object
slug string The slug of the shipper_account
status string The current status of the shipper account Accepts: enabled,disabled,deleted.
description string The description of the account
type string The type of the shipper_account Accepts: user,user_prepaid.
timezone string Use IANA — Time Zone Database
created_at string A formatted date.
settings shipper account settings Shipper Account Settings
updated_at string A formatted date.

Response example

No example available

DELETE Delete a shipper account

Try it 
/shipper-accounts/:id

Delete a shipper account

NameTypeDescription
id string id of referring object

Response example

No example available

GET List all shipper accounts

Try it 
/shipper-accounts

List all shipper accounts

NameTypeDescription
slug string Courier slug
limit string Number of records per page
next_token string Next token
NameTypeDescription
next_token string or null Any of string or null
limit string Number of records per page
shipper_accounts array of a shipper_account object A shipper_account object

Response example

No example available

GET Retrieve a shipper account

Try it 
/shipper-accounts/:id

Retrieve a shipper account

NameTypeDescription
id string Shipper Account ID
address address - shipper account Address object
slug string The slug of the shipper_account
status string The current status of the shipper account Accepts: enabled,disabled,deleted.
description string The description of the account
type string The type of the shipper_account Accepts: user,user_prepaid.
timezone string Use IANA — Time Zone Database
created_at string A formatted date.
updated_at string A formatted date.

Response example

No example available

PUT Update a shipper account credentials

Try it 
/shipper-accounts/:id/credentials

Update a shipper account credentials

NameTypeDescription
account_number string
password string
api_key string
NameTypeDescription
id string id of referring object

Response example

No example available

PUT Update a shipper account information

Try it 
/shipper-accounts/:id/info

Update a shipper account information

NameTypeDescription
description string The description of the account
timezone string Use IANA — Time Zone Database
address address - shipper account Address object
NameTypeDescription
id string Shipper Account ID
address address - shipper account Address object
slug string The slug of the shipper_account
status string The current status of the shipper account Accepts: enabled,disabled,deleted.
description string The description of the account
type string The type of the shipper_account Accepts: user,user_prepaid.
timezone string Use IANA — Time Zone Database
created_at string A formatted date.
updated_at string A formatted date.

Response example

No example available

PUT Update a shipper account

Try it 
/shipper-accounts/:id

Update a shipper account

NameTypeDescription

Response example

No example available

Bulk Downloads

Bulk Downloads

NameTypeDescription

POST Create a bulk download

Try it 
/bulk-downloads

Create a bulk download

NameTypeDescription
labels * array of reference Object reference
async boolean enable async mode or not (set to false if not provided)
NameTypeDescription
id string Bulk download label ID
status string Accepts: creating,created,failed.
files a files object A files object
labels array of reference Object reference
invalid_labels array of reference Object reference
created_at string A formatted date.
updated_at string A formatted date.

Response example

No example available

GET List all bulk downloads

Try it 
/bulk-downloads

List all bulk downloads

NameTypeDescription
status string Bulk Download Status Accepts: creating,created,failed.
limit string Number of records per page
created_at_min string Start date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: 24hrs ago)
created_at_max string End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ, default: NOW())
next_token string Next token
NameTypeDescription
bulk_downloads array of a bulk download object A bulk download object

Response example

No example available

GET Retrieve a bulk download

Try it 
/bulk-downloads/:id

Retrieve a bulk download

NameTypeDescription
id string Bulk download label ID
status string Accepts: creating,created,failed.
files a files object A files object
labels array of reference Object reference
invalid_labels array of reference Object reference
created_at string A formatted date.
updated_at string A formatted date.

Response example

No example available

Billing

Billing Object

NameTypeDescription
paid_by * string Accepts: shipper,third_party,recipient.
method payment method - account Payment Method - Account

Customs

Customs Object

NameTypeDescription
purpose * string Accepts: gift,merchandise,personal,sample,return,repair.
terms_of_trade string Accepts: dat,ddu,ddp,dap.
eei aes or no_eei EEI
billing customs billing Customs Billing Object
importer_address address Address object
passport passport Passport Object

Shipment

An instance of shipping freight or cargo

NameTypeDescription
ship_from * ship from address Address object
ship_to * ship to address Address object
parcels * array of parcel packages of shipment An object or collection of objects wrapped in paper in order to be carried or sent by post.
return_to return to address Address object
delivery_instructions string Instructions to aid in prompt delivery of the shipment.

Address

Address object

NameTypeDescription
country * string Country in ISO 3166-1 alpha 3 code Accepts: ABW,AFG,AGO,AIA,ALA,ALB,AND,ANT,ARE,ARG,ARM,ASM,ATA,ATF,ATG,AUS,AUT,AZE,BDI,BEL,BEN,BES,BFA,BGD,BGR,BHR,BHS,BIH,BLM,BLR,BLZ,BMU,BOL,BRA,BRB,BRN,BTN,BVT,BWA,CAF,CAN,CCK,CHE,CHL,CHN,CIV,CMR,COD,COG,COK,COL,COM,CPV,CRI,CUB,CUW,CXR,CYM,CYP,CZE,DEU,DJI,DMA,DNK,DOM,DZA,ECU,EGY,ERI,ESH,ESP,EST,ETH,FIN,FJI,FLK,FRA,FRO,FSM,GAB,GBR,GEO,GGY,GHA,GIB,GIN,GLP,GMB,GNB,GNQ,GRC,GRD,GRL,GTM,GUF,GUM,GUY,HKG,HMD,HND,HRV,HTI,HUN,IDN,IMN,IND,IOT,IRL,IRN,IRQ,ISL,ISR,ITA,JAM,JEY,JOR,JPN,KAZ,KEN,KGZ,KHM,KIR,KNA,KOR,KWT,LAO,LBN,LBR,LBY,LCA,LIE,LKA,LSO,LTU,LUX,LVA,MAC,MAF,MAR,MCO,MDA,MDG,MDV,MEX,MHL,MKD,MLI,MLT,MMR,MNE,MNG,MNP,MOZ,MRT,MSR,MTQ,MUS,MWI,MYS,MYT,NAM,NCL,NER,NFK,NGA,NIC,NIU,NLD,NOR,NPL,NRU,NZL,OMN,PAK,PAN,PCN,PER,PHL,PLW,PNG,POL,PRI,PRK,PRT,PRY,PSE,PYF,QAT,REU,ROU,RUS,RWA,SAU,SDN,SEN,SGP,SGS,SHN,SJM,SLB,SLE,SLV,SMR,SOM,SPM,SRB,SSD,STP,SUR,SVK,SVN,SWE,SWZ,SXM,SYC,SYR,TCA,TCD,TGO,THA,TJK,TKL,TKM,TLS,TON,TTO,TUN,TUR,TUV,TWN,TZA,UGA,UKR,UMI,UNK,URY,USA,UZB,VAT,VCT,VEN,VGB,VIR,VNM,VUT,WLF,WSM,YEM,ZAF,ZMB,ZWE.
contact_name string contact_name of address
phone string contact_phone of address
fax string fax_number of address
email string email of address
company_name string company_name of address
street1 string address_line1 of address
street2 string address_line2 of address
street3 string address_line3 of address
city string city of address
state string state of address
postal_code string postal_code of address
type string type of address Accepts: business,residential.
tax_id string tax id

Parcel

An object or collection of objects wrapped in paper in order to be carried or sent by post.

NameTypeDescription
box_type * string Type of box for packaging Accepts: custom,star-track_bag,star-track_carton,star-track_envelope,star-track_item,star-track_jiffy_bag,star-track_pallet,star-track_satchel,star-track_skid.
dimension * dimension dimension object
items * array of item items of package Item object, use to describe product to ship
description string The description of the parcel
weight weight weight object

Item

Item object, use to describe product to ship

NameTypeDescription
description * string The description of the item
quantity * integer The quantity for the item Minimum: 1
price * money money object
item_id string The ID of the item
origin_country string Country in ISO 3166-1 alpha 3 code Accepts: ABW,AFG,AGO,AIA,ALA,ALB,AND,ANT,ARE,ARG,ARM,ASM,ATA,ATF,ATG,AUS,AUT,AZE,BDI,BEL,BEN,BES,BFA,BGD,BGR,BHR,BHS,BIH,BLM,BLR,BLZ,BMU,BOL,BRA,BRB,BRN,BTN,BVT,BWA,CAF,CAN,CCK,CHE,CHL,CHN,CIV,CMR,COD,COG,COK,COL,COM,CPV,CRI,CUB,CUW,CXR,CYM,CYP,CZE,DEU,DJI,DMA,DNK,DOM,DZA,ECU,EGY,ERI,ESH,ESP,EST,ETH,FIN,FJI,FLK,FRA,FRO,FSM,GAB,GBR,GEO,GGY,GHA,GIB,GIN,GLP,GMB,GNB,GNQ,GRC,GRD,GRL,GTM,GUF,GUM,GUY,HKG,HMD,HND,HRV,HTI,HUN,IDN,IMN,IND,IOT,IRL,IRN,IRQ,ISL,ISR,ITA,JAM,JEY,JOR,JPN,KAZ,KEN,KGZ,KHM,KIR,KNA,KOR,KWT,LAO,LBN,LBR,LBY,LCA,LIE,LKA,LSO,LTU,LUX,LVA,MAC,MAF,MAR,MCO,MDA,MDG,MDV,MEX,MHL,MKD,MLI,MLT,MMR,MNE,MNG,MNP,MOZ,MRT,MSR,MTQ,MUS,MWI,MYS,MYT,NAM,NCL,NER,NFK,NGA,NIC,NIU,NLD,NOR,NPL,NRU,NZL,OMN,PAK,PAN,PCN,PER,PHL,PLW,PNG,POL,PRI,PRK,PRT,PRY,PSE,PYF,QAT,REU,ROU,RUS,RWA,SAU,SDN,SEN,SGP,SGS,SHN,SJM,SLB,SLE,SLV,SMR,SOM,SPM,SRB,SSD,STP,SUR,SVK,SVN,SWE,SWZ,SXM,SYC,SYR,TCA,TCD,TGO,THA,TJK,TKL,TKM,TLS,TON,TTO,TUN,TUR,TUV,TWN,TZA,UGA,UKR,UMI,UNK,URY,USA,UZB,VAT,VCT,VEN,VGB,VIR,VNM,VUT,WLF,WSM,YEM,ZAF,ZMB,ZWE.
weight weight weight object
sku string The sku of the item.
hs_code string The HS Code (Harmonized Commodity Description and Coding System) of the item.

A QR code file object

A QR code file object

NameTypeDescription
paper_size * string Paper Size Accepts: 1x1.
url * string URL of the file
file_type * string File Type Accepts: png.

A bulk download object

A bulk download object

NameTypeDescription
id string Bulk download label ID
status string Accepts: creating,created,failed.
files a files object A files object
labels array of reference Object reference
invalid_labels array of reference Object reference
created_at string A formatted date.
updated_at string A formatted date.

A cancel label object

A cancel label object

NameTypeDescription
id string Label ID
status string Accepts: cancelling,cancelled,failed.
refund_status string Accepts: requested,approved,rejected,refunded,expired.
label reference Object reference
created_at string A formatted date.
updated_at string A formatted date.

A customs declaration file object

A customs declaration file object

NameTypeDescription
paper_size * string Paper Size Accepts: 4x8,a4.
url * string URL of the file
file_type * string File Type Accepts: pdf.

A invoice file object

A invoice file object

NameTypeDescription
paper_size * string Paper Size Accepts: a4.
url * string URL of the file
file_type * string File Type Accepts: pdf.

A label file object

A label file object

NameTypeDescription
paper_size * string Label Paper Size Accepts: a4,4x6,default. (set to "default" if not provided)
url * string URL of the file
file_type * string Label file type Accepts: pdf. (set to "pdf" if not provided)

A label object

A label object

NameTypeDescription
id string Label ID
status string Accepts: creating,created,cancelling,cancelled,manifesting,manifested,failed.
ship_date string Ship Date in YYYY-MM-DD
tracking_numbers array of strings
files a files object A files object
rate rate type The amount of a charge or payment with reference to some basis of calculation.
created_at string A formatted date.
updated_at string A formatted date.

A manifest PDF file object

A manifest PDF file object

NameTypeDescription
paper_size * string Paper Size Accepts: a4.
url string URL of the file
file_type string File Type Accepts: pdf.

A manifest common file object

A manifest common file object

NameTypeDescription
url string URL of the file
paper_size string Paper Size Accepts: a4.
file_type string File Type Accepts: csv,dat,zip,txt,tsv.

A manifest object

A manifest object

NameTypeDescription
id string Manifest ID
status string Accepts: manifesting,manifested,failed.
shipper_account reference Object reference
labels array of a manifesting label object A manifesting label object
files a files object A files object
created_at string A formatted date.
updated_at string A formatted date.

A manifesting label object

A manifesting label object

NameTypeDescription
id * string Label ID
manifested * boolean

A rate record object

A rate record object

NameTypeDescription
id string Calculate Rate ID
status string Accepts: calculating,calculated,failed.
rates array of rate type The amount of a charge or payment with reference to some basis of calculation.
created_at string A formatted date.
updated_at string A formatted date.

A shipper_account object

A shipper_account object

NameTypeDescription
id string Shipper Account ID
address address - shipper account Address object
slug string The slug of the shipper_account
status string The current status of the shipper account Accepts: enabled,disabled,deleted.
description string The description of the account
type string The type of the shipper_account Accepts: user,user_prepaid.
timezone string Use IANA — Time Zone Database
created_at string A formatted date.
updated_at string A formatted date.

Address - Shipper Account

Address object

NameTypeDescription
contact_name string contact_name of address
phone string contact_phone of address
fax string fax_number of address
email string email of address
company_name string company_name of address
street1 string address_line1 of address
street2 string address_line2 of address
street3 string address_line3 of address
city string city of address
state string state of address
postal_code string postal_code of address
country string Country in ISO 3166-1 alpha 3 code Accepts: ABW,AFG,AGO,AIA,ALA,ALB,AND,ANT,ARE,ARG,ARM,ASM,ATA,ATF,ATG,AUS,AUT,AZE,BDI,BEL,BEN,BES,BFA,BGD,BGR,BHR,BHS,BIH,BLM,BLR,BLZ,BMU,BOL,BRA,BRB,BRN,BTN,BVT,BWA,CAF,CAN,CCK,CHE,CHL,CHN,CIV,CMR,COD,COG,COK,COL,COM,CPV,CRI,CUB,CUW,CXR,CYM,CYP,CZE,DEU,DJI,DMA,DNK,DOM,DZA,ECU,EGY,ERI,ESH,ESP,EST,ETH,FIN,FJI,FLK,FRA,FRO,FSM,GAB,GBR,GEO,GGY,GHA,GIB,GIN,GLP,GMB,GNB,GNQ,GRC,GRD,GRL,GTM,GUF,GUM,GUY,HKG,HMD,HND,HRV,HTI,HUN,IDN,IMN,IND,IOT,IRL,IRN,IRQ,ISL,ISR,ITA,JAM,JEY,JOR,JPN,KAZ,KEN,KGZ,KHM,KIR,KNA,KOR,KWT,LAO,LBN,LBR,LBY,LCA,LIE,LKA,LSO,LTU,LUX,LVA,MAC,MAF,MAR,MCO,MDA,MDG,MDV,MEX,MHL,MKD,MLI,MLT,MMR,MNE,MNG,MNP,MOZ,MRT,MSR,MTQ,MUS,MWI,MYS,MYT,NAM,NCL,NER,NFK,NGA,NIC,NIU,NLD,NOR,NPL,NRU,NZL,OMN,PAK,PAN,PCN,PER,PHL,PLW,PNG,POL,PRI,PRK,PRT,PRY,PSE,PYF,QAT,REU,ROU,RUS,RWA,SAU,SDN,SEN,SGP,SGS,SHN,SJM,SLB,SLE,SLV,SMR,SOM,SPM,SRB,SSD,STP,SUR,SVK,SVN,SWE,SWZ,SXM,SYC,SYR,TCA,TCD,TGO,THA,TJK,TKL,TKM,TLS,TON,TTO,TUN,TUR,TUV,TWN,TZA,UGA,UKR,UMI,UNK,URY,USA,UZB,VAT,VCT,VEN,VGB,VIR,VNM,VUT,WLF,WSM,YEM,ZAF,ZMB,ZWE.
type string type of address Accepts: business,residential.
tax_id string tax id

Address validation

Address validation request

NameTypeDescription
street1 * string address_line1 of address
country * string Country in ISO 3166-1 alpha 3 code Accepts: ANT,ARG,ABW,AUS,AUT,BHS,BRB,BEL,BMU,BRA,CAN,CYM,CHL,COL,CRI,CZE,DNK,DOM,EST,FIN,FRA,DEU,GRC,GTM,HKG,ITA,JAM,MYS,MEX,NLD,NZL,NOR,PAN,PER,PRT,SGP,ZAF,ESP,SWE,CHE,TTO,GBR,USA,URY,VEN,VGB.
contact_name string contact_name of address
phone string contact_phone of address
fax string fax_number of address
email string email of address
company_name string company_name of address
street2 string address_line2 of address
street3 string address_line3 of address
city string city of address
state string state of address
postal_code string postal_code of address
type string type of address Accepts: business,residential.
tax_id string tax id

Customs Billing

Customs Billing Object

NameTypeDescription
paid_by * string Accepts: shipper,recipient,third_party.
method payment method - account Payment Method - Account

Customs Declaration

Customs Declaration object

NameTypeDescription
number_of_copies integer Minimum: 1 , Maximum: 4

Detailed Charges

Detailed Charges object

NameTypeDescription
type string Detailed charges e.g. base, tax, fuel, discount etc.
charge money money object

Dimension

dimension object

NameTypeDescription
width * number width
height * number height
depth * number depth
unit * string unit Accepts: cm,in,mm,m,ft,yd.

FTP

FTP credentials object

NameTypeDescription
username * string username for ftp upload
password * string password for ftp upload

FTP

FTP credentials object

NameTypeDescription
url * string protocol://domain + port + path
username * string username for ftp upload
password * string password for ftp upload

Invoice

Invoice object, used to describe invoice type. Optional. Commercial invoice will be generated if field is present in the request body, else not.

NameTypeDescription
date * string Invoice date in YYYY-MM-DD
number string Invoice number
type string Accepts: commercial,proforma.
number_of_copies integer Minimum: 1 , Maximum: 4

Money

money object

NameTypeDescription
amount * number amount
currency * string Currency in ISO 4217 code Accepts: AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BOV,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHE,CHF,CHW,CLF,CLP,CNY,COP,COU,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LVL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MXV,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,SSP,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,USN,USS,UYI,UYU,UZS,VEF,VND,VUV,WST,XAF,XAG,XAU,XBA,XBB,XBC,XBD,XCD,XDR,XFU,XOF,XPD,XPF,XPT,XTS,XXX,YER,ZAR,ZMW.

Passport

Passport Object

NameTypeDescription
number * string Passport Number
issue_date * string Issue Date in YYYY-MM-DD

Payment Method - Account

Payment Method - Account

NameTypeDescription
type * string Accepts: account.
account_number * string account number
postal_code string Postal code
country string Country in ISO 3166-1 alpha 3 code Accepts: ABW,AFG,AGO,AIA,ALA,ALB,AND,ANT,ARE,ARG,ARM,ASM,ATA,ATF,ATG,AUS,AUT,AZE,BDI,BEL,BEN,BES,BFA,BGD,BGR,BHR,BHS,BIH,BLM,BLR,BLZ,BMU,BOL,BRA,BRB,BRN,BTN,BVT,BWA,CAF,CAN,CCK,CHE,CHL,CHN,CIV,CMR,COD,COG,COK,COL,COM,CPV,CRI,CUB,CUW,CXR,CYM,CYP,CZE,DEU,DJI,DMA,DNK,DOM,DZA,ECU,EGY,ERI,ESH,ESP,EST,ETH,FIN,FJI,FLK,FRA,FRO,FSM,GAB,GBR,GEO,GGY,GHA,GIB,GIN,GLP,GMB,GNB,GNQ,GRC,GRD,GRL,GTM,GUF,GUM,GUY,HKG,HMD,HND,HRV,HTI,HUN,IDN,IMN,IND,IOT,IRL,IRN,IRQ,ISL,ISR,ITA,JAM,JEY,JOR,JPN,KAZ,KEN,KGZ,KHM,KIR,KNA,KOR,KWT,LAO,LBN,LBR,LBY,LCA,LIE,LKA,LSO,LTU,LUX,LVA,MAC,MAF,MAR,MCO,MDA,MDG,MDV,MEX,MHL,MKD,MLI,MLT,MMR,MNE,MNG,MNP,MOZ,MRT,MSR,MTQ,MUS,MWI,MYS,MYT,NAM,NCL,NER,NFK,NGA,NIC,NIU,NLD,NOR,NPL,NRU,NZL,OMN,PAK,PAN,PCN,PER,PHL,PLW,PNG,POL,PRI,PRK,PRT,PRY,PSE,PYF,QAT,REU,ROU,RUS,RWA,SAU,SDN,SEN,SGP,SGS,SHN,SJM,SLB,SLE,SLV,SMR,SOM,SPM,SRB,SSD,STP,SUR,SVK,SVN,SWE,SWZ,SXM,SYC,SYR,TCA,TCD,TGO,THA,TJK,TKL,TKM,TLS,TON,TTO,TUN,TUR,TUV,TWN,TZA,UGA,UKR,UMI,UNK,URY,USA,UZB,VAT,VCT,VEN,VGB,VIR,VNM,VUT,WLF,WSM,YEM,ZAF,ZMB,ZWE.

Postmen error

An error object containing information about what went wrong.

NameTypeDescription
code integer
message string
details array of postmen meta A meta object containing information about what went wrong.
retryable boolean

Postmen meta

A meta object containing information about what went wrong.

NameTypeDescription
path string
info string

Rate type

The amount of a charge or payment with reference to some basis of calculation.

NameTypeDescription
shipper_account * shipper account information Shipper Account (brief information for rate and manifest responses)
service_type * string Service Types Accepts: star-track_afternoon_2u2day,star-track_cold_chain,star-track_express,star-track_express_courier,star-track_express_half_van,star-track_express_van,star-track_express_wagon,star-track_fixed_price_premium,star-track_immediate_priority_courier,star-track_immediate_priority_half_van,star-track_immediate_priority_van,star-track_immediate_priority_wagon,star-track_on_demand_now,star-track_on_demand_saturday,star-track_on_demand_tonight,star-track_premium,star-track_same_day_2u2day,star-track_saturday_2u2day,star-track_standard_courier,star-track_standard_half_van,star-track_standard_van,star-track_standard_wagon,star-track_twilight_2u2day.
service_name * string name of service
charge_weight weight weight object
total_charge money money object
pickup_deadline string A formatted date.
booking_cut_off string A formatted date.
delivery_date string A formatted date.
transit_time integer transit time
detailed_charges array of detailed charges Detailed Charges object
info_message string Info message of the rate result
error_message string Error message of the rate result

Service Option - Dangerous Goods

Dangerous Goods Service Option object

NameTypeDescription
type * string Accepts: dangerous_goods.
un_number string Four-digit UN/NA/ID numbers that identify dangerous goods, hazardous substances and articles.
technical_name string The technical name for the goods.
class string The class for the goods.
subsidiary_class string The subsidiary class for the goods.
packing_group string Dangerous goods are assigned into 3 packing groups (also known as UN Packing Group) in accordance with the degree of danger they present: Packing Group I: high danger, Packing Group II: medium danger, Packing Group III: low danger. Accepts: I,II,III.
packing_type string The type of this dangerous goods packing, as specified by the IATA packing instructions.For example, carton, steel cylinder, fiberboard box, plastic jerrican and steel drum.
packing_quantity integer The number of packing of the goods. Minimum: 1 (set to 1 if not provided)

Service Option - General

General Service Option object

NameTypeDescription
type * string Service Option General Type Accepts: signature.
enabled * boolean Accepts: true,false.

Service Option - Insurance

Insurance Service Option object

NameTypeDescription
type * string Accepts: insurance.
insured_value * money money object

Service Option - Pickup

Pickup Service Option object

NameTypeDescription
type * string Accepts: pickup.
start_time * string Preferred start of time period for pickup in HH:MM:SS
end_time string Preferred end of time period for pickup in HH:MM:SS

Ship From Address

Address object

NameTypeDescription
country * string Country in ISO 3166-1 alpha 3 code Accepts: ABW,AFG,AGO,AIA,ALA,ALB,AND,ANT,ARE,ARG,ARM,ASM,ATA,ATF,ATG,AUS,AUT,AZE,BDI,BEL,BEN,BES,BFA,BGD,BGR,BHR,BHS,BIH,BLM,BLR,BLZ,BMU,BOL,BRA,BRB,BRN,BTN,BVT,BWA,CAF,CAN,CCK,CHE,CHL,CHN,CIV,CMR,COD,COG,COK,COL,COM,CPV,CRI,CUB,CUW,CXR,CYM,CYP,CZE,DEU,DJI,DMA,DNK,DOM,DZA,ECU,EGY,ERI,ESH,ESP,EST,ETH,FIN,FJI,FLK,FRA,FRO,FSM,GAB,GBR,GEO,GGY,GHA,GIB,GIN,GLP,GMB,GNB,GNQ,GRC,GRD,GRL,GTM,GUF,GUM,GUY,HKG,HMD,HND,HRV,HTI,HUN,IDN,IMN,IND,IOT,IRL,IRN,IRQ,ISL,ISR,ITA,JAM,JEY,JOR,JPN,KAZ,KEN,KGZ,KHM,KIR,KNA,KOR,KWT,LAO,LBN,LBR,LBY,LCA,LIE,LKA,LSO,LTU,LUX,LVA,MAC,MAF,MAR,MCO,MDA,MDG,MDV,MEX,MHL,MKD,MLI,MLT,MMR,MNE,MNG,MNP,MOZ,MRT,MSR,MTQ,MUS,MWI,MYS,MYT,NAM,NCL,NER,NFK,NGA,NIC,NIU,NLD,NOR,NPL,NRU,NZL,OMN,PAK,PAN,PCN,PER,PHL,PLW,PNG,POL,PRI,PRK,PRT,PRY,PSE,PYF,QAT,REU,ROU,RUS,RWA,SAU,SDN,SEN,SGP,SGS,SHN,SJM,SLB,SLE,SLV,SMR,SOM,SPM,SRB,SSD,STP,SUR,SVK,SVN,SWE,SWZ,SXM,SYC,SYR,TCA,TCD,TGO,THA,TJK,TKL,TKM,TLS,TON,TTO,TUN,TUR,TUV,TWN,TZA,UGA,UKR,UMI,UNK,URY,USA,UZB,VAT,VCT,VEN,VGB,VIR,VNM,VUT,WLF,WSM,YEM,ZAF,ZMB,ZWE.
contact_name string contact_name of address
phone string contact_phone of address
fax string fax_number of address
email string email of address
company_name string company_name of address
street1 string address_line1 of address
street2 string address_line2 of address
street3 string address_line3 of address
city string city of address
state string state of address
postal_code string postal_code of address
type string type of address Accepts: business,residential.
tax_id string tax id

Ship To Address

Address object

NameTypeDescription
country * string Country in ISO 3166-1 alpha 3 code Accepts: ABW,AFG,AGO,AIA,ALA,ALB,AND,ANT,ARE,ARG,ARM,ASM,ATA,ATF,ATG,AUS,AUT,AZE,BDI,BEL,BEN,BES,BFA,BGD,BGR,BHR,BHS,BIH,BLM,BLR,BLZ,BMU,BOL,BRA,BRB,BRN,BTN,BVT,BWA,CAF,CAN,CCK,CHE,CHL,CHN,CIV,CMR,COD,COG,COK,COL,COM,CPV,CRI,CUB,CUW,CXR,CYM,CYP,CZE,DEU,DJI,DMA,DNK,DOM,DZA,ECU,EGY,ERI,ESH,ESP,EST,ETH,FIN,FJI,FLK,FRA,FRO,FSM,GAB,GBR,GEO,GGY,GHA,GIB,GIN,GLP,GMB,GNB,GNQ,GRC,GRD,GRL,GTM,GUF,GUM,GUY,HKG,HMD,HND,HRV,HTI,HUN,IDN,IMN,IND,IOT,IRL,IRN,IRQ,ISL,ISR,ITA,JAM,JEY,JOR,JPN,KAZ,KEN,KGZ,KHM,KIR,KNA,KOR,KWT,LAO,LBN,LBR,LBY,LCA,LIE,LKA,LSO,LTU,LUX,LVA,MAC,MAF,MAR,MCO,MDA,MDG,MDV,MEX,MHL,MKD,MLI,MLT,MMR,MNE,MNG,MNP,MOZ,MRT,MSR,MTQ,MUS,MWI,MYS,MYT,NAM,NCL,NER,NFK,NGA,NIC,NIU,NLD,NOR,NPL,NRU,NZL,OMN,PAK,PAN,PCN,PER,PHL,PLW,PNG,POL,PRI,PRK,PRT,PRY,PSE,PYF,QAT,REU,ROU,RUS,RWA,SAU,SDN,SEN,SGP,SGS,SHN,SJM,SLB,SLE,SLV,SMR,SOM,SPM,SRB,SSD,STP,SUR,SVK,SVN,SWE,SWZ,SXM,SYC,SYR,TCA,TCD,TGO,THA,TJK,TKL,TKM,TLS,TON,TTO,TUN,TUR,TUV,TWN,TZA,UGA,UKR,UMI,UNK,URY,USA,UZB,VAT,VCT,VEN,VGB,VIR,VNM,VUT,WLF,WSM,YEM,ZAF,ZMB,ZWE.
contact_name string contact_name of address
phone string contact_phone of address
fax string fax_number of address
email string email of address
company_name string company_name of address
street1 string address_line1 of address
street2 string address_line2 of address
street3 string address_line3 of address
city string city of address
state string state of address
postal_code string postal_code of address
type string type of address Accepts: business,residential.
tax_id string tax id

Shipper Account Credentials

Shipper Account Credentials

NameTypeDescription
account_number * string
password * string
api_key * string

Shipper Account Information

Shipper Account (brief information for rate and manifest responses)

NameTypeDescription
id * string Shipper Account ID
slug * string Courier Slug Accepts: star-track.
description string Shipper Account Description

Signature

Signature object

NameTypeDescription
id string id of referring object

Weight

weight object

NameTypeDescription
unit * string weight unit Accepts: lb,kg,oz,g.
value * number weight value

aes

EEI Type - aes

NameTypeDescription
type * string Accepts: aes.
itn_number * string ITN Number

no_eei

EEI Type - no_eei

NameTypeDescription
type * string Accepts: no_eei.
ftr_exemption * string Accepts: noeei_30_37_a,noeei_30_37_h,noeei_30_36.

reference

Object reference

NameTypeDescription
id * string id of referring object

return To Address

Address object

NameTypeDescription
country * string Country in ISO 3166-1 alpha 3 code Accepts: ABW,AFG,AGO,AIA,ALA,ALB,AND,ANT,ARE,ARG,ARM,ASM,ATA,ATF,ATG,AUS,AUT,AZE,BDI,BEL,BEN,BES,BFA,BGD,BGR,BHR,BHS,BIH,BLM,BLR,BLZ,BMU,BOL,BRA,BRB,BRN,BTN,BVT,BWA,CAF,CAN,CCK,CHE,CHL,CHN,CIV,CMR,COD,COG,COK,COL,COM,CPV,CRI,CUB,CUW,CXR,CYM,CYP,CZE,DEU,DJI,DMA,DNK,DOM,DZA,ECU,EGY,ERI,ESH,ESP,EST,ETH,FIN,FJI,FLK,FRA,FRO,FSM,GAB,GBR,GEO,GGY,GHA,GIB,GIN,GLP,GMB,GNB,GNQ,GRC,GRD,GRL,GTM,GUF,GUM,GUY,HKG,HMD,HND,HRV,HTI,HUN,IDN,IMN,IND,IOT,IRL,IRN,IRQ,ISL,ISR,ITA,JAM,JEY,JOR,JPN,KAZ,KEN,KGZ,KHM,KIR,KNA,KOR,KWT,LAO,LBN,LBR,LBY,LCA,LIE,LKA,LSO,LTU,LUX,LVA,MAC,MAF,MAR,MCO,MDA,MDG,MDV,MEX,MHL,MKD,MLI,MLT,MMR,MNE,MNG,MNP,MOZ,MRT,MSR,MTQ,MUS,MWI,MYS,MYT,NAM,NCL,NER,NFK,NGA,NIC,NIU,NLD,NOR,NPL,NRU,NZL,OMN,PAK,PAN,PCN,PER,PHL,PLW,PNG,POL,PRI,PRK,PRT,PRY,PSE,PYF,QAT,REU,ROU,RUS,RWA,SAU,SDN,SEN,SGP,SGS,SHN,SJM,SLB,SLE,SLV,SMR,SOM,SPM,SRB,SSD,STP,SUR,SVK,SVN,SWE,SWZ,SXM,SYC,SYR,TCA,TCD,TGO,THA,TJK,TKL,TKM,TLS,TON,TTO,TUN,TUR,TUV,TWN,TZA,UGA,UKR,UMI,UNK,URY,USA,UZB,VAT,VCT,VEN,VGB,VIR,VNM,VUT,WLF,WSM,YEM,ZAF,ZMB,ZWE.
contact_name string contact_name of address
phone string contact_phone of address
fax string fax_number of address
email string email of address
company_name string company_name of address
street1 string address_line1 of address
street2 string address_line2 of address
street3 string address_line3 of address
city string city of address
state string state of address
postal_code string postal_code of address
type string type of address Accepts: business,residential.
tax_id string tax id

address validation supported country Code

Country in ISO 3166-1 alpha 3 code

Accepts:
ANT,ARG,ABW,AUS,AUT,BHS,BRB,BEL,BMU,BRA,CAN,CYM,CHL,COL,CRI,CZE,DNK,DOM,EST,FIN,FRA,DEU,GRC,GTM,HKG,ITA,JAM,MYS,MEX,NLD,NZL,NOR,PAN,PER,PRT,SGP,ZAF,ESP,SWE,CHE,TTO,GBR,USA,URY,VEN,VGB.

Box Type

Type of box for packaging

Accepts:
custom,star-track_bag,star-track_carton,star-track_envelope,star-track_item,star-track_jiffy_bag,star-track_pallet,star-track_satchel,star-track_skid.

Bulk Download Status

Bulk Download Status

Accepts:
creating,created,failed.

Country Code

Country in ISO 3166-1 alpha 3 code

Accepts:
ABW,AFG,AGO,AIA,ALA,ALB,AND,ANT,ARE,ARG,ARM,ASM,ATA,ATF,ATG,AUS,AUT,AZE,BDI,BEL,BEN,BES,BFA,BGD,BGR,BHR,BHS,BIH,BLM,BLR,BLZ,BMU,BOL,BRA,BRB,BRN,BTN,BVT,BWA,CAF,CAN,CCK,CHE,CHL,CHN,CIV,CMR,COD,COG,COK,COL,COM,CPV,CRI,CUB,CUW,CXR,CYM,CYP,CZE,DEU,DJI,DMA,DNK,DOM,DZA,ECU,EGY,ERI,ESH,ESP,EST,ETH,FIN,FJI,FLK,FRA,FRO,FSM,GAB,GBR,GEO,GGY,GHA,GIB,GIN,GLP,GMB,GNB,GNQ,GRC,GRD,GRL,GTM,GUF,GUM,GUY,HKG,HMD,HND,HRV,HTI,HUN,IDN,IMN,IND,IOT,IRL,IRN,IRQ,ISL,ISR,ITA,JAM,JEY,JOR,JPN,KAZ,KEN,KGZ,KHM,KIR,KNA,KOR,KWT,LAO,LBN,LBR,LBY,LCA,LIE,LKA,LSO,LTU,LUX,LVA,MAC,MAF,MAR,MCO,MDA,MDG,MDV,MEX,MHL,MKD,MLI,MLT,MMR,MNE,MNG,MNP,MOZ,MRT,MSR,MTQ,MUS,MWI,MYS,MYT,NAM,NCL,NER,NFK,NGA,NIC,NIU,NLD,NOR,NPL,NRU,NZL,OMN,PAK,PAN,PCN,PER,PHL,PLW,PNG,POL,PRI,PRK,PRT,PRY,PSE,PYF,QAT,REU,ROU,RUS,RWA,SAU,SDN,SEN,SGP,SGS,SHN,SJM,SLB,SLE,SLV,SMR,SOM,SPM,SRB,SSD,STP,SUR,SVK,SVN,SWE,SWZ,SXM,SYC,SYR,TCA,TCD,TGO,THA,TJK,TKL,TKM,TLS,TON,TTO,TUN,TUR,TUV,TWN,TZA,UGA,UKR,UMI,UNK,URY,USA,UZB,VAT,VCT,VEN,VGB,VIR,VNM,VUT,WLF,WSM,YEM,ZAF,ZMB,ZWE.

Currency Code

Currency in ISO 4217 code

Accepts:
AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BOV,BRL,BSD,BTN,BWP,BYR,BZD,CAD,CDF,CHE,CHF,CHW,CLF,CLP,CNY,COP,COU,CRC,CUC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LVL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MUR,MVR,MWK,MXN,MXV,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,SSP,STD,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,USN,USS,UYI,UYU,UZS,VEF,VND,VUV,WST,XAF,XAG,XAU,XBA,XBB,XBC,XBD,XCD,XDR,XFU,XOF,XPD,XPF,XPT,XTS,XXX,YER,ZAR,ZMW.

Label File Type

Label file type

Accepts:
pdf.

Label Paper Size

Label Paper Size

Accepts:
a4,4x6,default.

A manifest file object

Postmen Date

A formatted date.

Accepted formats:
YYYY-MM-DDTHH:mm:ss.SSSZ YYYY-MM-DDTHH:mm:ssZ YYYY-MM-DDTHH:mm:ss YYYY-MM-DDTHH:mmZ YYYY-MM-DDTHH:mm YYYY-MM-DD HH:mm:ss HH:mm

Postmen float

A float number.

Postmen integer

Postmen order number

A user-defined order number used to identify an order.

Min length:
1
Max length:
50

Postmen status

Status of Task

Accepts:
pending,success,failed,complete.

Postmen string

A string with a maximum length of 255 characters.

Min length:
1
Max length:
255

Label References

Reference numbers for a label

Service Option General Type

Service Option General Type

Accepts:
signature.

Service Type

Service Types

Accepts:
star-track_afternoon_2u2day,star-track_cold_chain,star-track_express,star-track_express_courier,star-track_express_half_van,star-track_express_van,star-track_express_wagon,star-track_fixed_price_premium,star-track_immediate_priority_courier,star-track_immediate_priority_half_van,star-track_immediate_priority_van,star-track_immediate_priority_wagon,star-track_on_demand_now,star-track_on_demand_saturday,star-track_on_demand_tonight,star-track_premium,star-track_same_day_2u2day,star-track_saturday_2u2day,star-track_standard_courier,star-track_standard_half_van,star-track_standard_van,star-track_standard_wagon,star-track_twilight_2u2day.

Shipper Account Settings

Shipper Account Settings

Courier Slug

Courier Slug

Accepts:
star-track.

Timezone

Use IANA — Time Zone Database

Accepts:
Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Asmara,Africa/Asmera,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/El_Aaiun,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Timbuktu,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anchorage,America/Anguilla,America/Antigua,America/Araguaina,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/ComodRivadavia,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/La_Rioja,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Argentina/Ushuaia,America/Aruba,America/Asuncion,America/Atikokan,America/Atka,America/Bahia,America/Bahia_Banderas,America/Barbados,America/Belem,America/Belize,America/Blanc-Sablon,America/Boa_Vista,America/Bogota,America/Boise,America/Buenos_Aires,America/Cambridge_Bay,America/Campo_Grande,America/Cancun,America/Caracas,America/Catamarca,America/Cayenne,America/Cayman,America/Chicago,America/Chihuahua,America/Coral_Harbour,America/Cordoba,America/Costa_Rica,America/Creston,America/Cuiaba,America/Curacao,America/Danmarkshavn,America/Dawson,America/Dawson_Creek,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/Eirunepe,America/El_Salvador,America/Ensenada,America/Fort_Nelson,America/Fort_Wayne,America/Fortaleza,America/Glace_Bay,America/Godthab,America/Goose_Bay,America/Grand_Turk,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Knox,America/Indiana/Marengo,America/Indiana/Petersburg,America/Indiana/Tell_City,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indiana/Winamac,America/Indianapolis,America/Inuvik,America/Iqaluit,America/Jamaica,America/Jujuy,America/Juneau,America/Kentucky/Louisville,America/Kentucky/Monticello,America/Knox_IN,America/Kralendijk,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Lower_Princes,America/Maceio,America/Managua,America/Manaus,America/Marigot,America/Martinique,America/Matamoros,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Metlakatla,America/Mexico_City,America/Miquelon,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Montserrat,America/Nassau,America/New_York,America/Nipigon,America/Nome,America/Noronha,America/North_Dakota/Beulah,America/North_Dakota/Center,America/North_Dakota/New_Salem,America/Ojinaga,America/Panama,America/Pangnirtung,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Port_of_Spain,America/Porto_Acre,America/Porto_Velho,America/Puerto_Rico,America/Punta_Arenas,America/Rainy_River,America/Rankin_Inlet,America/Recife,America/Regina,America/Resolute,America/Rio_Branco,America/Rosario,America/Santa_Isabel,America/Santarem,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/Shiprock,America/Sitka,America/St_Barthelemy,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/St_Vincent,America/Swift_Current,America/Tegucigalpa,America/Thule,America/Thunder_Bay,America/Tijuana,America/Toronto,America/Tortola,America/Vancouver,America/Virgin,America/Whitehorse,America/Winnipeg,America/Yakutat,America/Yellowknife,Antarctica/Casey,Antarctica/Davis,Antarctica/DumontDUrville,Antarctica/Macquarie,Antarctica/Mawson,Antarctica/McMurdo,Antarctica/Palmer,Antarctica/Rothera,Antarctica/South_Pole,Antarctica/Syowa,Antarctica/Troll,Antarctica/Vostok,Arctic/Longyearbyen,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Anadyr,Asia/Aqtau,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Atyrau,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Barnaul,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Choibalsan,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dili,Asia/Dubai,Asia/Dushanbe,Asia/Famagusta,Asia/Gaza,Asia/Harbin,Asia/Hebron,Asia/Ho_Chi_Minh,Asia/Hong_Kong,Asia/Hovd,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Kamchatka,Asia/Karachi,Asia/Kashgar,Asia/Kathmandu,Asia/Katmandu,Asia/Khandyga,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Magadan,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pontianak,Asia/Pyongyang,Asia/Qatar,Asia/Qyzylorda,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Srednekolymsk,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimbu,Asia/Thimphu,Asia/Tokyo,Asia/Tomsk,Asia/Ujung_Pandang,Asia/Ulaanbaatar,Asia/Ulan_Bator,Asia/Urumqi,Asia/Ust-Nera,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yangon,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Jan_Mayen,Atlantic/Madeira,Atlantic/Reykjavik,Atlantic/South_Georgia,Atlantic/St_Helena,Atlantic/Stanley,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Broken_Hill,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Eucla,Australia/Hobart,Australia/LHI,Australia/Lindeman,Australia/Lord_Howe,Australia/Melbourne,Australia/NSW,Australia/North,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Australia/Yancowinna,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/East-Saskatchewan,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,Canada/Saskatchewan,Canada/Yukon,Chile/Continental,Chile/EasterIsland,Europe/Amsterdam,Europe/Andorra,Europe/Astrakhan,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Busingen,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Guernsey,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Jersey,Europe/Kaliningrad,Europe/Kiev,Europe/Kirov,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Mariehamn,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Saratov,Europe/Simferopol,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Ulyanovsk,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,Indian/Antananarivo,Indian/Chagos,Indian/Christmas,Indian/Cocos,Indian/Comoro,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Mayotte,Indian/Reunion,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,Pacific/Apia,Pacific/Auckland,Pacific/Bougainville,Pacific/Chatham,Pacific/Chuuk,Pacific/Easter,Pacific/Efate,Pacific/Enderbury,Pacific/Fakaofo,Pacific/Fiji,Pacific/Funafuti,Pacific/Galapagos,Pacific/Gambier,Pacific/Guadalcanal,Pacific/Guam,Pacific/Honolulu,Pacific/Johnston,Pacific/Kiritimati,Pacific/Kosrae,Pacific/Kwajalein,Pacific/Majuro,Pacific/Marquesas,Pacific/Midway,Pacific/Nauru,Pacific/Niue,Pacific/Norfolk,Pacific/Noumea,Pacific/Pago_Pago,Pacific/Palau,Pacific/Pitcairn,Pacific/Pohnpei,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Rarotonga,Pacific/Saipan,Pacific/Samoa,Pacific/Tahiti,Pacific/Tarawa,Pacific/Tongatapu,Pacific/Truk,Pacific/Wake,Pacific/Wallis,Pacific/Yap,US/Alaska,US/Aleutian,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,US/Samoa,UTC.

Ship date

Ship Date in YYYY-MM-DD, if not provided, will be today of the shipper account timezone

Accepted formats:
YYYY-MM-DD