Couriers Please API Documentation

POST Calculate rates

/rates

Calculate rates

Request
Response

Name	Type	Description
`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


	{
	  "async": false,
	  "shipper_accounts": [
	    {
	      "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2"
	    }
	  ],
	  "is_document": false,
	  "shipment": {
	    "ship_from": {
	      "contact_name": "Mr.Panda",
	      "company_name": "Bode, Lind and Powlowski",
	      "email": "dev@yahoo.com",
	      "phone": "1-140-225-6414",
	      "street1": "8918 Borer Ramp",
	      "city": "Hongkong",
	      "state": "CA",
	      "postal_code": "518000",
	      "country": "HKG",
	      "type": "business"
	    },
	    "ship_to": {
	      "contact_name": "Dr. Panda",
	      "phone": "1-140-225-6410",
	      "email": "panda@panda.com",
	      "street1": "28292 Daugherty Orchard",
	      "city": "MELBOURNE",
	      "country": "AUS",
	      "postal_code": "3000",
	      "type": "residential"
	    },
	    "parcels": [
	      {
	        "description": "iMac (Retina 5K, 27-inch, Late 2014)",
	        "box_type": "custom",
	        "weight": {
	          "value": 9.54,
	          "unit": "kg"
	        },
	        "dimension": {
	          "width": 65,
	          "height": 52,
	          "depth": 21,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "iMac (Retina 5K, 27-inch, Late 2014)",
	            "origin_country": "USA",
	            "quantity": 1,
	            "price": {
	              "amount": 1999,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 9.54,
	              "unit": "kg"
	            },
	            "sku": "imac2014"
	          }
	        ]
	      }
	    ]
	  }
	}


	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 '{"async":false,"shipper_accounts":[{"id":"42b255fe-d732-4cae-bc2e-8d19ca095ac2"}],"is_document":false,"shipment":{"ship_from":{"contact_name":"Mr.Panda","company_name":"Bode, Lind and Powlowski","email":"dev@yahoo.com","phone":"1-140-225-6414","street1":"8918 Borer Ramp","city":"Hongkong","state":"CA","postal_code":"518000","country":"HKG","type":"business"},"ship_to":{"contact_name":"Dr. Panda","phone":"1-140-225-6410","email":"panda@panda.com","street1":"28292 Daugherty Orchard","city":"MELBOURNE","country":"AUS","postal_code":"3000","type":"residential"},"parcels":[{"description":"iMac (Retina 5K, 27-inch, Late 2014)","box_type":"custom","weight":{"value":9.54,"unit":"kg"},"dimension":{"width":65,"height":52,"depth":21,"unit":"cm"},"items":[{"description":"iMac (Retina 5K, 27-inch, Late 2014)","origin_country":"USA","quantity":1,"price":{"amount":1999,"currency":"AUD"},"weight":{"value":9.54,"unit":"kg"},"sku":"imac2014"}]}]}}'


	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 = "{\"async\":false,\"shipper_accounts\":[{\"id\":\"42b255fe-d732-4cae-bc2e-8d19ca095ac2\"}],\"is_document\":false,\"shipment\":{\"ship_from\":{\"contact_name\":\"Mr.Panda\",\"company_name\":\"Bode, Lind and Powlowski\",\"email\":\"dev@yahoo.com\",\"phone\":\"1-140-225-6414\",\"street1\":\"8918 Borer Ramp\",\"city\":\"Hongkong\",\"state\":\"CA\",\"postal_code\":\"518000\",\"country\":\"HKG\",\"type\":\"business\"},\"ship_to\":{\"contact_name\":\"Dr. Panda\",\"phone\":\"1-140-225-6410\",\"email\":\"panda@panda.com\",\"street1\":\"28292 Daugherty Orchard\",\"city\":\"MELBOURNE\",\"country\":\"AUS\",\"postal_code\":\"3000\",\"type\":\"residential\"},\"parcels\":[{\"description\":\"iMac (Retina 5K, 27-inch, Late 2014)\",\"box_type\":\"custom\",\"weight\":{\"value\":9.54,\"unit\":\"kg\"},\"dimension\":{\"width\":65,\"height\":52,\"depth\":21,\"unit\":\"cm\"},\"items\":[{\"description\":\"iMac (Retina 5K, 27-inch, Late 2014)\",\"origin_country\":\"USA\",\"quantity\":1,\"price\":{\"amount\":1999,\"currency\":\"AUD\"},\"weight\":{\"value\":9.54,\"unit\":\"kg\"},\"sku\":\"imac2014\"}]}]}}";
	
	        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, "{\"async\":false,\"shipper_accounts\":[{\"id\":\"42b255fe-d732-4cae-bc2e-8d19ca095ac2\"}],\"is_document\":false,\"shipment\":{\"ship_from\":{\"contact_name\":\"Mr.Panda\",\"company_name\":\"Bode, Lind and Powlowski\",\"email\":\"dev@yahoo.com\",\"phone\":\"1-140-225-6414\",\"street1\":\"8918 Borer Ramp\",\"city\":\"Hongkong\",\"state\":\"CA\",\"postal_code\":\"518000\",\"country\":\"HKG\",\"type\":\"business\"},\"ship_to\":{\"contact_name\":\"Dr. Panda\",\"phone\":\"1-140-225-6410\",\"email\":\"panda@panda.com\",\"street1\":\"28292 Daugherty Orchard\",\"city\":\"MELBOURNE\",\"country\":\"AUS\",\"postal_code\":\"3000\",\"type\":\"residential\"},\"parcels\":[{\"description\":\"iMac (Retina 5K, 27-inch, Late 2014)\",\"box_type\":\"custom\",\"weight\":{\"value\":9.54,\"unit\":\"kg\"},\"dimension\":{\"width\":65,\"height\":52,\"depth\":21,\"unit\":\"cm\"},\"items\":[{\"description\":\"iMac (Retina 5K, 27-inch, Late 2014)\",\"origin_country\":\"USA\",\"quantity\":1,\"price\":{\"amount\":1999,\"currency\":\"AUD\"},\"weight\":{\"value\":9.54,\"unit\":\"kg\"},\"sku\":\"imac2014\"}]}]}}");
	
	    	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: '{"async":false,"shipper_accounts":[{"id":"42b255fe-d732-4cae-bc2e-8d19ca095ac2"}],"is_document":false,"shipment":{"ship_from":{"contact_name":"Mr.Panda","company_name":"Bode, Lind and Powlowski","email":"dev@yahoo.com","phone":"1-140-225-6414","street1":"8918 Borer Ramp","city":"Hongkong","state":"CA","postal_code":"518000","country":"HKG","type":"business"},"ship_to":{"contact_name":"Dr. Panda","phone":"1-140-225-6410","email":"panda@panda.com","street1":"28292 Daugherty Orchard","city":"MELBOURNE","country":"AUS","postal_code":"3000","type":"residential"},"parcels":[{"description":"iMac (Retina 5K, 27-inch, Late 2014)","box_type":"custom","weight":{"value":9.54,"unit":"kg"},"dimension":{"width":65,"height":52,"depth":21,"unit":"cm"},"items":[{"description":"iMac (Retina 5K, 27-inch, Late 2014)","origin_country":"USA","quantity":1,"price":{"amount":1999,"currency":"AUD"},"weight":{"value":9.54,"unit":"kg"},"sku":"imac2014"}]}]}}'
	};
	
	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 = '{"async":false,"shipper_accounts":[{"id":"42b255fe-d732-4cae-bc2e-8d19ca095ac2"}],"is_document":false,"shipment":{"ship_from":{"contact_name":"Mr.Panda","company_name":"Bode, Lind and Powlowski","email":"dev@yahoo.com","phone":"1-140-225-6414","street1":"8918 Borer Ramp","city":"Hongkong","state":"CA","postal_code":"518000","country":"HKG","type":"business"},"ship_to":{"contact_name":"Dr. Panda","phone":"1-140-225-6410","email":"panda@panda.com","street1":"28292 Daugherty Orchard","city":"MELBOURNE","country":"AUS","postal_code":"3000","type":"residential"},"parcels":[{"description":"iMac (Retina 5K, 27-inch, Late 2014)","box_type":"custom","weight":{"value":9.54,"unit":"kg"},"dimension":{"width":65,"height":52,"depth":21,"unit":"cm"},"items":[{"description":"iMac (Retina 5K, 27-inch, Late 2014)","origin_country":"USA","quantity":1,"price":{"amount":1999,"currency":"AUD"},"weight":{"value":9.54,"unit":"kg"},"sku":"imac2014"}]}]}}';
	
	    $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 = '''
	{
	  "async": false,
	  "shipper_accounts": [
	    {
	      "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2"
	    }
	  ],
	  "is_document": false,
	  "shipment": {
	    "ship_from": {
	      "contact_name": "Mr.Panda",
	      "company_name": "Bode, Lind and Powlowski",
	      "email": "dev@yahoo.com",
	      "phone": "1-140-225-6414",
	      "street1": "8918 Borer Ramp",
	      "city": "Hongkong",
	      "state": "CA",
	      "postal_code": "518000",
	      "country": "HKG",
	      "type": "business"
	    },
	    "ship_to": {
	      "contact_name": "Dr. Panda",
	      "phone": "1-140-225-6410",
	      "email": "panda@panda.com",
	      "street1": "28292 Daugherty Orchard",
	      "city": "MELBOURNE",
	      "country": "AUS",
	      "postal_code": "3000",
	      "type": "residential"
	    },
	    "parcels": [
	      {
	        "description": "iMac (Retina 5K, 27-inch, Late 2014)",
	        "box_type": "custom",
	        "weight": {
	          "value": 9.54,
	          "unit": "kg"
	        },
	        "dimension": {
	          "width": 65,
	          "height": 52,
	          "depth": 21,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "iMac (Retina 5K, 27-inch, Late 2014)",
	            "origin_country": "USA",
	            "quantity": 1,
	            "price": {
	              "amount": 1999,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 9.54,
	              "unit": "kg"
	            },
	            "sku": "imac2014"
	          }
	        ]
	      }
	    ]
	  }
	}
	'''
	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 = '{"async":false,"shipper_accounts":[{"id":"42b255fe-d732-4cae-bc2e-8d19ca095ac2"}],"is_document":false,"shipment":{"ship_from":{"contact_name":"Mr.Panda","company_name":"Bode, Lind and Powlowski","email":"dev@yahoo.com","phone":"1-140-225-6414","street1":"8918 Borer Ramp","city":"Hongkong","state":"CA","postal_code":"518000","country":"HKG","type":"business"},"ship_to":{"contact_name":"Dr. Panda","phone":"1-140-225-6410","email":"panda@panda.com","street1":"28292 Daugherty Orchard","city":"MELBOURNE","country":"AUS","postal_code":"3000","type":"residential"},"parcels":[{"description":"iMac (Retina 5K, 27-inch, Late 2014)","box_type":"custom","weight":{"value":9.54,"unit":"kg"},"dimension":{"width":65,"height":52,"depth":21,"unit":"cm"},"items":[{"description":"iMac (Retina 5K, 27-inch, Late 2014)","origin_country":"USA","quantity":1,"price":{"amount":1999,"currency":"AUD"},"weight":{"value":9.54,"unit":"kg"},"sku":"imac2014"}]}]}}'
	
	response = http.request(request)
	puts response.read_body

Name	Type	Description
`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-03-21T08:14:51+00:00",
	    "id": "e6ff8a69-54ab-492e-85ad-22a4b5c4bf2e",
	    "updated_at": "2019-03-21T08:14:53+00:00",
	    "status": "calculated",
	    "rates": [
	      {
	        "service_type": "couriers-please_international_express_import_e",
	        "service_name": "Couriers Please International  Express Import(E)",
	        "info_message": "1-2 Business Days",
	        "charge_weight": {
	          "value": 14.2,
	          "unit": "kg"
	        },
	        "total_charge": {
	          "amount": 186.04,
	          "currency": "AUD"
	        },
	        "detailed_charges": [
	          {
	            "type": "base",
	            "charge": {
	              "amount": 160.38,
	              "currency": "AUD"
	            }
	          },
	          {
	            "type": "fuel_surcharge",
	            "charge": {
	              "amount": 25.66,
	              "currency": "AUD"
	            }
	          }
	        ],
	        "transit_time": 2,
	        "shipper_account": {
	          "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2",
	          "slug": "couriers-please",
	          "description": "couriers-please"
	        }
	      }
	    ]
	  }
	}

GET List all rates

Try it

/rates

List all rates

Request
Response

Optional parameters

Name	Type	Description
`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 or YYYY-MM-DDTHH:MM:SS+00:00, default: 24hrs ago)
`created_at_max`	string	End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, 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

Name	Type	Description
`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

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "next_token": "1",
	    "limit": 1,
	    "created_at_min": "2019-04-18T09:23:21+00:00",
	    "created_at_max": "2019-09-19T10:17:22+00:00",
	    "rates": [
	      {
	        "service_type": "international_express_import_e",
	        "service_name": "International  Express Import(E)",
	        "info_message": "1-2 Business Days",
	        "charge_weight": {
	          "value": 14.2,
	          "unit": "kg"
	        },
	        "total_charge": {
	          "amount": 186.04,
	          "currency": "AUD"
	        },
	        "detailed_charges": [
	          {
	            "type": "base",
	            "charge": {
	              "amount": 160.38,
	              "currency": "AUD"
	            }
	          },
	          {
	            "type": "fuel_surcharge",
	            "charge": {
	              "amount": 25.66,
	              "currency": "AUD"
	            }
	          }
	        ],
	        "transit_time": 2,
	        "shipper_account": {
	          "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2",
	          "slug": "couriers-please",
	          "description": "couriers-please"
	        }
	      }
	    ]
	  }
	}

GET Retrieve rates

Try it

/rates/:id

Retrieve rates

Request
Response

{}


	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

Name	Type	Description
`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-03-21T08:14:51+00:00",
	    "id": "e6ff8a69-54ab-492e-85ad-22a4b5c4bf2e",
	    "updated_at": "2019-03-21T08:14:53+00:00",
	    "status": "calculated",
	    "rates": [
	      {
	        "service_type": "international_express_import_e",
	        "service_name": "International  Express Import(E)",
	        "info_message": "1-2 Business Days",
	        "charge_weight": {
	          "value": 14.2,
	          "unit": "kg"
	        },
	        "total_charge": {
	          "amount": 186.04,
	          "currency": "AUD"
	        },
	        "detailed_charges": [
	          {
	            "type": "base",
	            "charge": {
	              "amount": 160.38,
	              "currency": "AUD"
	            }
	          },
	          {
	            "type": "fuel_surcharge",
	            "charge": {
	              "amount": 25.66,
	              "currency": "AUD"
	            }
	          }
	        ],
	        "transit_time": 2,
	        "shipper_account": {
	          "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2",
	          "slug": "couriers-please",
	          "description": "couriers-please"
	        }
	      }
	    ]
	  }
	}

POST Create a label

Try it

/labels

Create a label

Request
Response

Name	Type	Description
`service_type` *	string	Service Types Accepts: `couriers-please_10kg_parcel`,`couriers-please_1kg_parcel`,`couriers-please_1kg_satchel`,`couriers-please_1kg_satchel_atl`,`couriers-please_25kg_parcel`,`couriers-please_3kg_parcel`,`couriers-please_3kg_satchel`,`couriers-please_3kg_satchel_atl`,`couriers-please_500gram_parcel`,`couriers-please_500gram_parcel_atl`,`couriers-please_500gram_satchel`,`couriers-please_500gram_satchel_atl`,`couriers-please_5kg_parcel`,`couriers-please_5kg_satchel`,`couriers-please_5kg_satchel_atl`,`couriers-please_express_rate_international_priority_a`,`couriers-please_international_express_d`,`couriers-please_international_express_import_e`,`couriers-please_international_express_import_i`,`couriers-please_international_express_w`,`couriers-please_international_saver`,`couriers-please_international_saver_w`,`couriers-please_road_express_49`,`couriers-please_road_express_49L`,`couriers-please_road_express_i05`,`couriers-please_road_express_i10`,`couriers-please_road_express_i11`,`couriers-please_road_express_i22`,`couriers-please_road_express_i33`,`couriers-please_road_express_i44`,`couriers-please_road_express_i50`,`couriers-please_road_express_i55`,`couriers-please_road_express_i66`,`couriers-please_road_express_i77`,`couriers-please_road_express_l05`,`couriers-please_road_express_l10`,`couriers-please_road_express_l11`,`couriers-please_road_express_l22`,`couriers-please_road_express_l33`,`couriers-please_road_express_l44`,`couriers-please_road_express_l50`,`couriers-please_road_express_l55`,`couriers-please_road_express_l66`,`couriers-please_road_express_l77`.
`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: `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 - pickup	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.
`order_id`	string	Unique identification of the order.


	{
	  "async": false,
	  "return_shipment": false,
	  "paper_size": "default",
	  "service_type": "couriers-please_road_express_l11",
	  "references": [
	    "xxx-123456"
	  ],
	  "service_options": [
	    {
	      "type": "insurance",
	      "insured_value": {
	        "amount": 10,
	        "currency": "AUD"
	      }
	    }
	  ],
	  "customs": {
	    "purpose": "merchandise",
	    "terms_of_trade": "ddp"
	  },
	  "shipper_account": {
	    "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2"
	  },
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.5,
	          "unit": "kg"
	        },
	        "dimension": {
	          "width": 20,
	          "height": 30,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "DEU",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar",
	            "hs_code": "11111111"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "country": "AUS",
	      "contact_name": "Panda",
	      "phone": "0987654321",
	      "fax": null,
	      "email": "panda@panda.com",
	      "company_name": "Panda of china",
	      "street1": "Weiseler Str.",
	      "city": "Rosehill",
	      "state": "mixed",
	      "postal_code": "2142",
	      "type": "business"
	    },
	    "ship_to": {
	      "contact_name": "Panda Frank",
	      "street1": "Haydnstr.",
	      "city": "MELBOURNE",
	      "postal_code": "3000",
	      "country": "AUS",
	      "state": "vil",
	      "phone": "1300 361 000",
	      "email": "test@test.test",
	      "type": "residential"
	    }
	  }
	}


	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 '{"async":false,"return_shipment":false,"paper_size":"default","service_type":"couriers-please_road_express_l11","references":["xxx-123456"],"service_options":[{"type":"insurance","insured_value":{"amount":10,"currency":"AUD"}}],"customs":{"purpose":"merchandise","terms_of_trade":"ddp"},"shipper_account":{"id":"42b255fe-d732-4cae-bc2e-8d19ca095ac2"},"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.5,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"DEU","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar","hs_code":"11111111"}]}],"ship_from":{"country":"AUS","contact_name":"Panda","phone":"0987654321","fax":null,"email":"panda@panda.com","company_name":"Panda of china","street1":"Weiseler Str.","city":"Rosehill","state":"mixed","postal_code":"2142","type":"business"},"ship_to":{"contact_name":"Panda Frank","street1":"Haydnstr.","city":"MELBOURNE","postal_code":"3000","country":"AUS","state":"vil","phone":"1300 361 000","email":"test@test.test","type":"residential"}}}'


	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 = "{\"async\":false,\"return_shipment\":false,\"paper_size\":\"default\",\"service_type\":\"couriers-please_road_express_l11\",\"references\":[\"xxx-123456\"],\"service_options\":[{\"type\":\"insurance\",\"insured_value\":{\"amount\":10,\"currency\":\"AUD\"}}],\"customs\":{\"purpose\":\"merchandise\",\"terms_of_trade\":\"ddp\"},\"shipper_account\":{\"id\":\"42b255fe-d732-4cae-bc2e-8d19ca095ac2\"},\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.5,\"unit\":\"kg\"},\"dimension\":{\"width\":20,\"height\":30,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"DEU\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"AUD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\",\"hs_code\":\"11111111\"}]}],\"ship_from\":{\"country\":\"AUS\",\"contact_name\":\"Panda\",\"phone\":\"0987654321\",\"fax\":null,\"email\":\"panda@panda.com\",\"company_name\":\"Panda of china\",\"street1\":\"Weiseler Str.\",\"city\":\"Rosehill\",\"state\":\"mixed\",\"postal_code\":\"2142\",\"type\":\"business\"},\"ship_to\":{\"contact_name\":\"Panda Frank\",\"street1\":\"Haydnstr.\",\"city\":\"MELBOURNE\",\"postal_code\":\"3000\",\"country\":\"AUS\",\"state\":\"vil\",\"phone\":\"1300 361 000\",\"email\":\"test@test.test\",\"type\":\"residential\"}}}";
	
	        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, "{\"async\":false,\"return_shipment\":false,\"paper_size\":\"default\",\"service_type\":\"couriers-please_road_express_l11\",\"references\":[\"xxx-123456\"],\"service_options\":[{\"type\":\"insurance\",\"insured_value\":{\"amount\":10,\"currency\":\"AUD\"}}],\"customs\":{\"purpose\":\"merchandise\",\"terms_of_trade\":\"ddp\"},\"shipper_account\":{\"id\":\"42b255fe-d732-4cae-bc2e-8d19ca095ac2\"},\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.5,\"unit\":\"kg\"},\"dimension\":{\"width\":20,\"height\":30,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"DEU\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"AUD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\",\"hs_code\":\"11111111\"}]}],\"ship_from\":{\"country\":\"AUS\",\"contact_name\":\"Panda\",\"phone\":\"0987654321\",\"fax\":null,\"email\":\"panda@panda.com\",\"company_name\":\"Panda of china\",\"street1\":\"Weiseler Str.\",\"city\":\"Rosehill\",\"state\":\"mixed\",\"postal_code\":\"2142\",\"type\":\"business\"},\"ship_to\":{\"contact_name\":\"Panda Frank\",\"street1\":\"Haydnstr.\",\"city\":\"MELBOURNE\",\"postal_code\":\"3000\",\"country\":\"AUS\",\"state\":\"vil\",\"phone\":\"1300 361 000\",\"email\":\"test@test.test\",\"type\":\"residential\"}}}");
	
	    	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: '{"async":false,"return_shipment":false,"paper_size":"default","service_type":"couriers-please_road_express_l11","references":["xxx-123456"],"service_options":[{"type":"insurance","insured_value":{"amount":10,"currency":"AUD"}}],"customs":{"purpose":"merchandise","terms_of_trade":"ddp"},"shipper_account":{"id":"42b255fe-d732-4cae-bc2e-8d19ca095ac2"},"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.5,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"DEU","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar","hs_code":"11111111"}]}],"ship_from":{"country":"AUS","contact_name":"Panda","phone":"0987654321","fax":null,"email":"panda@panda.com","company_name":"Panda of china","street1":"Weiseler Str.","city":"Rosehill","state":"mixed","postal_code":"2142","type":"business"},"ship_to":{"contact_name":"Panda Frank","street1":"Haydnstr.","city":"MELBOURNE","postal_code":"3000","country":"AUS","state":"vil","phone":"1300 361 000","email":"test@test.test","type":"residential"}}}'
	};
	
	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 = '{"async":false,"return_shipment":false,"paper_size":"default","service_type":"couriers-please_road_express_l11","references":["xxx-123456"],"service_options":[{"type":"insurance","insured_value":{"amount":10,"currency":"AUD"}}],"customs":{"purpose":"merchandise","terms_of_trade":"ddp"},"shipper_account":{"id":"42b255fe-d732-4cae-bc2e-8d19ca095ac2"},"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.5,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"DEU","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar","hs_code":"11111111"}]}],"ship_from":{"country":"AUS","contact_name":"Panda","phone":"0987654321","fax":null,"email":"panda@panda.com","company_name":"Panda of china","street1":"Weiseler Str.","city":"Rosehill","state":"mixed","postal_code":"2142","type":"business"},"ship_to":{"contact_name":"Panda Frank","street1":"Haydnstr.","city":"MELBOURNE","postal_code":"3000","country":"AUS","state":"vil","phone":"1300 361 000","email":"test@test.test","type":"residential"}}}';
	
	    $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 = '''
	{
	  "async": false,
	  "return_shipment": false,
	  "paper_size": "default",
	  "service_type": "couriers-please_road_express_l11",
	  "references": [
	    "xxx-123456"
	  ],
	  "service_options": [
	    {
	      "type": "insurance",
	      "insured_value": {
	        "amount": 10,
	        "currency": "AUD"
	      }
	    }
	  ],
	  "customs": {
	    "purpose": "merchandise",
	    "terms_of_trade": "ddp"
	  },
	  "shipper_account": {
	    "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2"
	  },
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.5,
	          "unit": "kg"
	        },
	        "dimension": {
	          "width": 20,
	          "height": 30,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "DEU",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "AUD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar",
	            "hs_code": "11111111"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "country": "AUS",
	      "contact_name": "Panda",
	      "phone": "0987654321",
	      "fax": null,
	      "email": "panda@panda.com",
	      "company_name": "Panda of china",
	      "street1": "Weiseler Str.",
	      "city": "Rosehill",
	      "state": "mixed",
	      "postal_code": "2142",
	      "type": "business"
	    },
	    "ship_to": {
	      "contact_name": "Panda Frank",
	      "street1": "Haydnstr.",
	      "city": "MELBOURNE",
	      "postal_code": "3000",
	      "country": "AUS",
	      "state": "vil",
	      "phone": "1300 361 000",
	      "email": "test@test.test",
	      "type": "residential"
	    }
	  }
	}
	'''
	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 = '{"async":false,"return_shipment":false,"paper_size":"default","service_type":"couriers-please_road_express_l11","references":["xxx-123456"],"service_options":[{"type":"insurance","insured_value":{"amount":10,"currency":"AUD"}}],"customs":{"purpose":"merchandise","terms_of_trade":"ddp"},"shipper_account":{"id":"42b255fe-d732-4cae-bc2e-8d19ca095ac2"},"shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.5,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"DEU","quantity":2,"price":{"amount":50,"currency":"AUD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar","hs_code":"11111111"}]}],"ship_from":{"country":"AUS","contact_name":"Panda","phone":"0987654321","fax":null,"email":"panda@panda.com","company_name":"Panda of china","street1":"Weiseler Str.","city":"Rosehill","state":"mixed","postal_code":"2142","type":"business"},"ship_to":{"contact_name":"Panda Frank","street1":"Haydnstr.","city":"MELBOURNE","postal_code":"3000","country":"AUS","state":"vil","phone":"1300 361 000","email":"test@test.test","type":"residential"}}}'
	
	response = http.request(request)
	puts response.read_body

Name	Type	Description
`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: `couriers-please_10kg_parcel`,`couriers-please_1kg_parcel`,`couriers-please_1kg_satchel`,`couriers-please_1kg_satchel_atl`,`couriers-please_25kg_parcel`,`couriers-please_3kg_parcel`,`couriers-please_3kg_satchel`,`couriers-please_3kg_satchel_atl`,`couriers-please_500gram_parcel`,`couriers-please_500gram_parcel_atl`,`couriers-please_500gram_satchel`,`couriers-please_500gram_satchel_atl`,`couriers-please_5kg_parcel`,`couriers-please_5kg_satchel`,`couriers-please_5kg_satchel_atl`,`couriers-please_express_rate_international_priority_a`,`couriers-please_international_express_d`,`couriers-please_international_express_import_e`,`couriers-please_international_express_import_i`,`couriers-please_international_express_w`,`couriers-please_international_saver`,`couriers-please_international_saver_w`,`couriers-please_road_express_49`,`couriers-please_road_express_49L`,`couriers-please_road_express_i05`,`couriers-please_road_express_i10`,`couriers-please_road_express_i11`,`couriers-please_road_express_i22`,`couriers-please_road_express_i33`,`couriers-please_road_express_i44`,`couriers-please_road_express_i50`,`couriers-please_road_express_i55`,`couriers-please_road_express_i66`,`couriers-please_road_express_i77`,`couriers-please_road_express_l05`,`couriers-please_road_express_l10`,`couriers-please_road_express_l11`,`couriers-please_road_express_l22`,`couriers-please_road_express_l33`,`couriers-please_road_express_l44`,`couriers-please_road_express_l50`,`couriers-please_road_express_l55`,`couriers-please_road_express_l66`,`couriers-please_road_express_l77`.

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "tracking_numbers": [
	      "CPWL11000000489-TEST"
	    ],
	    "files": {
	      "label": {
	        "paper_size": "default",
	        "url": "https://sandbox-download.postmen.com/label/2015-11-27/00000000-0000-0000-0000-0000000083300-1441785264309885.pdf",
	        "file_type": "pdf"
	      }
	    },
	    "rate": {
	      "service_type": "couriers-please_road_express_l11",
	      "service_name": "Couriers Please Road Express - L11",
	      "shipper_account": {
	        "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2",
	        "slug": "couriers-please",
	        "description": "couriers-please"
	      },
	      "info_message": "No rate quotes returned from carrier."
	    },
	    "created_at": "2019-03-23T09:14:51+00:00",
	    "updated_at": "2019-03-23T09:14:56+00:00",
	    "ship_date": "2019-03-21",
	    "status": "created",
	    "id": "00a47dc7-e549-4f1b-9488-950f35345dd8"
	  }
	}

GET Retrieve a label

Try it

/labels/:id

Retrieve a label

Request
Response

{}


	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

Name	Type	Description
`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": "3318b97b-150f-4205-840d-a6d966b9e0ea",
	    "status": "created",
	    "tracking_numbers": [
	      "3884930103"
	    ],
	    "files": {
	      "label": {
	        "paper_size": "default",
	        "url": "https://sandbox-download.postmen.com/label/2019-03-21/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
	        "file_type": "pdf"
	      },
	      "invoice": null,
	      "customs_declaration": null,
	      "manifest": null
	    },
	    "rate": {
	      "service_type": "road_express_l11",
	      "service_name": "Road Express - L11",
	      "shipper_account": {
	        "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2",
	        "slug": "couriers-please",
	        "description": "couriers-please"
	      },
	      "info_message": "No rate quotes returned from carrier."
	    },
	    "created_at": "2015-09-09T07:54:13.024Z",
	    "updated_at": "2015-09-09T07:54:24.569Z"
	  }
	}

GET List all labels

Try it

/labels

List all labels

Request
Response

Optional parameters

Name	Type	Description
`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 or YYYY-MM-DDTHH:MM:SS+00:00, default: 24hrs ago)
`created_at_max`	string	End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, 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

Name	Type	Description
`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": "eyJjcmVhdGVkX2F0IjoiMjAxNS0xMS0y0000000000oyMC4wNjRaIiwiaWQiOiJlMGU1NGQ3My1iN2Qz0000000000kzZi1lMjgwNzc1ZDdlMDUiLCJ1c2VyX2lkIjoiN0000000000tNjIyNS00ZTBiLTg5ZTQtZTM3N2M3YWM5ZDk4In0=",
	    "limit": 1,
	    "created_at_min": "2019-03-21T08:49:15+00:00",
	    "created_at_max": "2019-03-21T08:49:15+00:00",
	    "labels": [
	      {
	        "id": "ca62aa0d-e8b2-4ea7-b3b1-ee6711d8d7c3",
	        "status": "created",
	        "tracking_numbers": [
	          "1ZV8E0536793432874"
	        ],
	        "files": {
	          "label": {
	            "paper_size": "4x6",
	            "url": "https://sandbox-download.postmen.com/label/2019-03-21/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/invoice/2019-03-21/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
	            "file_type": "pdf"
	          },
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "rate": {
	          "service_type": "road_express_l11",
	          "service_name": "Road Express - L11",
	          "shipper_account": {
	            "id": "42b255fe-d732-4cae-bc2e-8d19ca095ac2",
	            "slug": "couriers-please",
	            "description": "couriers-please"
	          },
	          "info_message": "No rate quotes returned from carrier."
	        },
	        "created_at": "2019-03-21T08:48:31+00:00",
	        "updated_at": "2019-03-21T08:48:35+00:00"
	      }
	    ]
	  }
	}

POST Create a shipper account

Try it

/shipper-accounts

Create a shipper account

Request
Response

Name	Type	Description
`slug`	string	Courier Slug Accepts: `couriers-please`.
`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

Name	Type	Description
`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

Request
Response

Name	Type	Description
`id`	string	id of referring object

Response example

No example available

GET List all shipper accounts

Try it

/shipper-accounts

List all shipper accounts

Request
Response

Optional parameters

Name	Type	Description
`slug`	string	Courier slug
`limit`	string	Number of records per page
`next_token`	string	Next token

Name	Type	Description
`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

Request
Response

Name	Type	Description
`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

Request
Response

Name	Type	Description
`username`	string
`password`	string

Name	Type	Description
`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

Request
Response

Name	Type	Description
`description`	string	The description of the account
`timezone`	string	Use IANA — Time Zone Database
`address`	address - shipper account	Address object

Name	Type	Description
`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

Request
Response

Name	Type	Description

Response example

No example available

POST Create a bulk download

Try it

/bulk-downloads

Create a bulk download

Request
Response

Name	Type	Description
`labels` *	array of reference	Object reference
`async`	boolean	enable async mode or not (set to `false` if not provided)

Name	Type	Description
`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

Request
Response

Optional parameters

Name	Type	Description
`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 or YYYY-MM-DDTHH:MM:SS+00:00, default: 24hrs ago)
`created_at_max`	string	End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, default: NOW())
`next_token`	string	Next token

Name	Type	Description
`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

Request
Response

Name	Type	Description
`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

POST Create an address validation

Try it

/address-validations

Create an address validation

Request
Response

Name	Type	Description
`address` *	address - address validation	Address object

Request example

	{
	  "address": {
	    "contact_name": "testing",
	    "street1": "4901 N New Hope Rd Apt C1",
	    "city": "Raleigh",
	    "state": "NC",
	    "postal_code": "27604",
	    "country": "USA",
	    "type": "business",
	    "phone": "17578976058",
	    "email": "testing@gmail.com"
	  }
	}

Name	Type	Description
`id`	string	Request ID
`status`	string	Validation result of the address. Accepts: `valid`,`invalid`.
`created_at`	string	A formatted date.
`updated_at`	string	A formatted date.
`address`	address - address validation	Address object
`recommended_address`	address - address validation	Address object

Response example

	{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "b234f43e-a87f-4b97-baf8-dc49fefd5110",
	    "status": "valid",
	    "created_at": "2021-03-01T09:22:40Z",
	    "updated_at": "2021-03-01T09:22:45Z",
	    "address": {
	      "country": "USA",
	      "contact_name": "testing",
	      "phone": "17578976058",
	      "fax": null,
	      "email": "testing@gmail.com",
	      "company_name": null,
	      "street1": "4901 N New Hope Rd Apt C1",
	      "street2": null,
	      "street3": null,
	      "city": "Raleigh",
	      "state": "NC",
	      "postal_code": "27604",
	      "type": "business",
	      "tax_id": null
	    },
	    "recommended_address": {
	      "country": "USA",
	      "contact_name": null,
	      "phone": null,
	      "fax": null,
	      "email": null,
	      "company_name": null,
	      "street1": "4901 N NEW HOPE RD APT C1",
	      "street2": null,
	      "street3": null,
	      "city": "RALEIGH",
	      "state": "NC",
	      "postal_code": "27604-4494",
	      "type": null,
	      "tax_id": null
	    }
	  }
	}

Name	Type	Description
`paid_by` *	string	Accepts: `shipper`,`third_party`,`recipient`.
`method`	payment method - account	Payment Method - Account

Name	Type	Description
`purpose` *	string	Accepts: `gift`,`merchandise`,`sample`,`other`,`document`.
`terms_of_trade`	string	Accepts: `dat`,`ddu`,`ddp`,`dap`.
`eei`	aes or no_eei	EEI
`importer_address`	address	Address object
`passport`	passport	Passport Object

Name	Type	Description
`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.

Name	Type	Description
`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

Name	Type	Description
`box_type` *	string	Type of box for packaging Accepts: `custom`.
`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

Name	Type	Description
`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.

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

Name	Type	Description
`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.

Name	Type	Description
`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.

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

Name	Type	Description
`label`	a label file object	A label file object
`qr_code`	a qr code file object	A QR code file object
`invoice`	a invoice file object	A invoice file object
`customs_declaration`	a customs declaration file object	A customs declaration file object
`manifest`	a manifest pdf file object or a manifest common file object object	A manifest file object

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

Name	Type	Description
`paper_size` *	string	Label Paper Size Accepts: `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)

Name	Type	Description
`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.

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

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

Name	Type	Description
`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.

Name	Type	Description
`id` *	string	Label ID
`manifested` *	boolean

Name	Type	Description
`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.

Name	Type	Description
`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.

Name	Type	Description
`street1` *	string	address_line1 of address
`country` *	string	Country in ISO 3166-1 alpha 3 code Accepts: `USA`.
`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

Name	Type	Description
`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

Name	Type	Description
`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`.

Name	Type	Description
`shipper_account` *	shipper account information	Shipper Account (brief information for rate and manifest responses)
`service_type` *	string	Service Types Accepts: `couriers-please_10kg_parcel`,`couriers-please_1kg_parcel`,`couriers-please_1kg_satchel`,`couriers-please_1kg_satchel_atl`,`couriers-please_25kg_parcel`,`couriers-please_3kg_parcel`,`couriers-please_3kg_satchel`,`couriers-please_3kg_satchel_atl`,`couriers-please_500gram_parcel`,`couriers-please_500gram_parcel_atl`,`couriers-please_500gram_satchel`,`couriers-please_500gram_satchel_atl`,`couriers-please_5kg_parcel`,`couriers-please_5kg_satchel`,`couriers-please_5kg_satchel_atl`,`couriers-please_express_rate_international_priority_a`,`couriers-please_international_express_d`,`couriers-please_international_express_import_e`,`couriers-please_international_express_import_i`,`couriers-please_international_express_w`,`couriers-please_international_saver`,`couriers-please_international_saver_w`,`couriers-please_road_express_49`,`couriers-please_road_express_49L`,`couriers-please_road_express_i05`,`couriers-please_road_express_i10`,`couriers-please_road_express_i11`,`couriers-please_road_express_i22`,`couriers-please_road_express_i33`,`couriers-please_road_express_i44`,`couriers-please_road_express_i50`,`couriers-please_road_express_i55`,`couriers-please_road_express_i66`,`couriers-please_road_express_i77`,`couriers-please_road_express_l05`,`couriers-please_road_express_l10`,`couriers-please_road_express_l11`,`couriers-please_road_express_l22`,`couriers-please_road_express_l33`,`couriers-please_road_express_l44`,`couriers-please_road_express_l50`,`couriers-please_road_express_l55`,`couriers-please_road_express_l66`,`couriers-please_road_express_l77`.
`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

Name	Type	Description
`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

Name	Type	Description
`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

Name	Type	Description
`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

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.

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.

Accepts:: couriers-please_10kg_parcel,couriers-please_1kg_parcel,couriers-please_1kg_satchel,couriers-please_1kg_satchel_atl,couriers-please_25kg_parcel,couriers-please_3kg_parcel,couriers-please_3kg_satchel,couriers-please_3kg_satchel_atl,couriers-please_500gram_parcel,couriers-please_500gram_parcel_atl,couriers-please_500gram_satchel,couriers-please_500gram_satchel_atl,couriers-please_5kg_parcel,couriers-please_5kg_satchel,couriers-please_5kg_satchel_atl,couriers-please_express_rate_international_priority_a,couriers-please_international_express_d,couriers-please_international_express_import_e,couriers-please_international_express_import_i,couriers-please_international_express_w,couriers-please_international_saver,couriers-please_international_saver_w,couriers-please_road_express_49,couriers-please_road_express_49L,couriers-please_road_express_i05,couriers-please_road_express_i10,couriers-please_road_express_i11,couriers-please_road_express_i22,couriers-please_road_express_i33,couriers-please_road_express_i44,couriers-please_road_express_i50,couriers-please_road_express_i55,couriers-please_road_express_i66,couriers-please_road_express_i77,couriers-please_road_express_l05,couriers-please_road_express_l10,couriers-please_road_express_l11,couriers-please_road_express_l22,couriers-please_road_express_l33,couriers-please_road_express_l44,couriers-please_road_express_l50,couriers-please_road_express_l55,couriers-please_road_express_l66,couriers-please_road_express_l77.

Postmen API docs for Couriers Please

Rates

POST Calculate rates

Response example

GET List all rates

Optional parameters

Response example

GET Retrieve rates

Response example

Labels

POST Create a label

Response example

GET Retrieve a label

Response example

GET List all labels

Optional parameters

Response example

Shipper Accounts

POST Create a shipper account

Response example

DELETE Delete a shipper account

Response example

GET List all shipper accounts

Optional parameters

Response example

GET Retrieve a shipper account

Response example

PUT Update a shipper account credentials

Response example

PUT Update a shipper account information

Response example

PUT Update a shipper account

Response example

Bulk Downloads

POST Create a bulk download

Response example

GET List all bulk downloads

Optional parameters

Response example

GET Retrieve a bulk download

Response example

Address Validations

POST Create an address validation

Request example

Response example

Billing

Customs

Shipment

Address

Parcel

Item

A QR code file object

A bulk download object

A cancel label object

A customs declaration file object

A files object

A invoice file object

A label file object

A label object

A manifest PDF file object

A manifest common file object

A manifest object

A manifesting label object

A rate record object

A shipper_account object

Address - Address Validation

Address - Shipper Account

Customs Billing

Customs Declaration

Detailed Charges

Dimension

FTP

FTP

Invoice

Money

Passport

Payment Method - Account

Postmen error

Postmen meta

Rate type