OmniParcel API Documentation

POST Create a label

/labels

Create a label

Request
Response

Name	Type	Description
`service_type` *	string	Service Types Accepts: `omniparcel_forward`,`omniparcel_return`.
`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: `4x8`,`a4`,`default`. (set to `"default"` 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 - general	Service options
`is_document`	boolean	If the shipment is document type. (set to `false` if not provided)
`invoice`	invoice	Invoice object, use to describe invoice
`references`	array of strings	Reference numbers for a label
`billing`	billing	Billing Object
`customs`	customs	Customs Object


	{
	  "customs": {
	    "billing": {
	      "paid_by": "recipient",
	      "method": {
	        "account_number": "12345",
	        "type": "account"
	      }
	    },
	    "purpose": "gift"
	  },
	  "service_type": "omniparcel_return",
	  "return_shipment": false,
	  "shipper_account": {
	    "id": "00000000-0000-0000-0000-000000000000"
	  },
	  "paper_size": "default",
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "width": 20,
	          "height": 30,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "item_id": "13131313",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "USD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      },
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "width": 20,
	          "height": 30,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "USD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "contact_name": "Duncan",
	      "company_name": "Hicom Glenmarie",
	      "street1": "long long ago",
	      "country": "AUS",
	      "phone": "1-403-504-5496",
	      "email": "test@test.com",
	      "state": "New South Wales",
	      "city": "GLENWOOD",
	      "type": "business",
	      "postal_code": "2768"
	    },
	    "ship_to": {
	      "contact_name": "Panda",
	      "company_name": "Hicom Glenmarie ",
	      "street1": "australia city",
	      "country": "AUS",
	      "phone": "1-403-504-5496",
	      "email": "test2@panda.com",
	      "type": "residential",
	      "postal_code": "2190",
	      "city": "Chullora",
	      "state": "NSW"
	    }
	  },
	  "billing": {
	    "paid_by": "shipper",
	    "method": {
	      "account_number": "12344",
	      "type": "account"
	    }
	  },
	  "async": false,
	  "is_document": false,
	  "references": [
	    "950000002"
	  ]
	}


	curl --request POST \
	    --url https://sandbox-api.postmen.com/v3/labels \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"customs":{"billing":{"paid_by":"recipient","method":{"account_number":"12345","type":"account"}},"purpose":"gift"},"service_type":"omniparcel_return","return_shipment":false,"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"paper_size":"default","shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","item_id":"13131313","quantity":2,"price":{"amount":50,"currency":"USD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]},{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"USD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"Duncan","company_name":"Hicom Glenmarie","street1":"long long ago","country":"AUS","phone":"1-403-504-5496","email":"test@test.com","state":"New South Wales","city":"GLENWOOD","type":"business","postal_code":"2768"},"ship_to":{"contact_name":"Panda","company_name":"Hicom Glenmarie ","street1":"australia city","country":"AUS","phone":"1-403-504-5496","email":"test2@panda.com","type":"residential","postal_code":"2190","city":"Chullora","state":"NSW"}},"billing":{"paid_by":"shipper","method":{"account_number":"12344","type":"account"}},"async":false,"is_document":false,"references":["950000002"]}'


	using System;
	using System.Net;
	using System.IO;
	
	class ExamplePostmen
	{
	    static void Main(string[] args)
		{
	        WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/labels");
	        string json = "{\"customs\":{\"billing\":{\"paid_by\":\"recipient\",\"method\":{\"account_number\":\"12345\",\"type\":\"account\"}},\"purpose\":\"gift\"},\"service_type\":\"omniparcel_return\",\"return_shipment\":false,\"shipper_account\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"paper_size\":\"default\",\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"width\":20,\"height\":30,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"item_id\":\"13131313\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"USD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]},{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"width\":20,\"height\":30,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"USD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]}],\"ship_from\":{\"contact_name\":\"Duncan\",\"company_name\":\"Hicom Glenmarie\",\"street1\":\"long long ago\",\"country\":\"AUS\",\"phone\":\"1-403-504-5496\",\"email\":\"test@test.com\",\"state\":\"New South Wales\",\"city\":\"GLENWOOD\",\"type\":\"business\",\"postal_code\":\"2768\"},\"ship_to\":{\"contact_name\":\"Panda\",\"company_name\":\"Hicom Glenmarie \",\"street1\":\"australia city\",\"country\":\"AUS\",\"phone\":\"1-403-504-5496\",\"email\":\"test2@panda.com\",\"type\":\"residential\",\"postal_code\":\"2190\",\"city\":\"Chullora\",\"state\":\"NSW\"}},\"billing\":{\"paid_by\":\"shipper\",\"method\":{\"account_number\":\"12344\",\"type\":\"account\"}},\"async\":false,\"is_document\":false,\"references\":[\"950000002\"]}";
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "POST";
	        httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
	
	        using (StreamWriter streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
	        {
	            streamWriter.Write(json);
	            streamWriter.Flush();
	            streamWriter.Close();
	        }
	
	        HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
	        using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
	        {
	            string result = streamReader.ReadToEnd();
	            Console.WriteLine(result);
	        }
	    }
	}


	import com.squareup.okhttp.*;
	
	public class test {
	
	    public static void main(String[] args) {
		    OkHttpClient client = new OkHttpClient();
	
	    	MediaType mediaType = MediaType.parse("application/json");
	        RequestBody body = RequestBody.create(mediaType, "{\"customs\":{\"billing\":{\"paid_by\":\"recipient\",\"method\":{\"account_number\":\"12345\",\"type\":\"account\"}},\"purpose\":\"gift\"},\"service_type\":\"omniparcel_return\",\"return_shipment\":false,\"shipper_account\":{\"id\":\"00000000-0000-0000-0000-000000000000\"},\"paper_size\":\"default\",\"shipment\":{\"parcels\":[{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"width\":20,\"height\":30,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"item_id\":\"13131313\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"USD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]},{\"box_type\":\"custom\",\"weight\":{\"value\":1.2,\"unit\":\"kg\"},\"dimension\":{\"width\":20,\"height\":30,\"depth\":40,\"unit\":\"cm\"},\"items\":[{\"description\":\"Food Bar\",\"origin_country\":\"AUS\",\"quantity\":2,\"price\":{\"amount\":50,\"currency\":\"USD\"},\"weight\":{\"value\":0.6,\"unit\":\"kg\"},\"sku\":\"Epic_Food_Bar\"}]}],\"ship_from\":{\"contact_name\":\"Duncan\",\"company_name\":\"Hicom Glenmarie\",\"street1\":\"long long ago\",\"country\":\"AUS\",\"phone\":\"1-403-504-5496\",\"email\":\"test@test.com\",\"state\":\"New South Wales\",\"city\":\"GLENWOOD\",\"type\":\"business\",\"postal_code\":\"2768\"},\"ship_to\":{\"contact_name\":\"Panda\",\"company_name\":\"Hicom Glenmarie \",\"street1\":\"australia city\",\"country\":\"AUS\",\"phone\":\"1-403-504-5496\",\"email\":\"test2@panda.com\",\"type\":\"residential\",\"postal_code\":\"2190\",\"city\":\"Chullora\",\"state\":\"NSW\"}},\"billing\":{\"paid_by\":\"shipper\",\"method\":{\"account_number\":\"12344\",\"type\":\"account\"}},\"async\":false,\"is_document\":false,\"references\":[\"950000002\"]}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/labels")
	            .post(body)
	    		.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
	    		.addHeader("content-type", "application/json")
	    		.build();
	
	    	try {
	    		Response response = client.newCall(request).execute();
	    		System.out.println(response.body().string());
	    	} catch (Exception e) {
	    		System.err.println("Caught IOException: " + e.getMessage());
	    	}
	    }
	}

var request = require("request");
	var options = {
		method: 'POST',
	    url: 'https://sandbox-api.postmen.com/v3/labels',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"customs":{"billing":{"paid_by":"recipient","method":{"account_number":"12345","type":"account"}},"purpose":"gift"},"service_type":"omniparcel_return","return_shipment":false,"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"paper_size":"default","shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","item_id":"13131313","quantity":2,"price":{"amount":50,"currency":"USD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]},{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"USD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"Duncan","company_name":"Hicom Glenmarie","street1":"long long ago","country":"AUS","phone":"1-403-504-5496","email":"test@test.com","state":"New South Wales","city":"GLENWOOD","type":"business","postal_code":"2768"},"ship_to":{"contact_name":"Panda","company_name":"Hicom Glenmarie ","street1":"australia city","country":"AUS","phone":"1-403-504-5496","email":"test2@panda.com","type":"residential","postal_code":"2190","city":"Chullora","state":"NSW"}},"billing":{"paid_by":"shipper","method":{"account_number":"12344","type":"account"}},"async":false,"is_document":false,"references":["950000002"]}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});


	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/labels';
	    $method = 'POST';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"customs":{"billing":{"paid_by":"recipient","method":{"account_number":"12345","type":"account"}},"purpose":"gift"},"service_type":"omniparcel_return","return_shipment":false,"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"paper_size":"default","shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","item_id":"13131313","quantity":2,"price":{"amount":50,"currency":"USD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]},{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"USD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"Duncan","company_name":"Hicom Glenmarie","street1":"long long ago","country":"AUS","phone":"1-403-504-5496","email":"test@test.com","state":"New South Wales","city":"GLENWOOD","type":"business","postal_code":"2768"},"ship_to":{"contact_name":"Panda","company_name":"Hicom Glenmarie ","street1":"australia city","country":"AUS","phone":"1-403-504-5496","email":"test2@panda.com","type":"residential","postal_code":"2190","city":"Chullora","state":"NSW"}},"billing":{"paid_by":"shipper","method":{"account_number":"12344","type":"account"}},"async":false,"is_document":false,"references":["950000002"]}';
	
	    $curl = curl_init();
	
	    curl_setopt_array($curl, array(
	        CURLOPT_RETURNTRANSFER => true,
	        CURLOPT_URL => $url,
	        CURLOPT_CUSTOMREQUEST => $method,
	        CURLOPT_HTTPHEADER => $headers,
			CURLOPT_POSTFIELDS => $body
	    ));
	
	    $response = curl_exec($curl);
	    $err = curl_error($curl);
	
	    curl_close($curl);
	
	    if ($err) {
	    	echo "cURL Error #:" . $err;
	    } else {
	    	echo $response;
	    }
	?>


	# Make sure to install requests: pip install requests
	import requests
	
	url = 'https://sandbox-api.postmen.com/v3/labels'
	
	payload = '''
	{
	  "customs": {
	    "billing": {
	      "paid_by": "recipient",
	      "method": {
	        "account_number": "12345",
	        "type": "account"
	      }
	    },
	    "purpose": "gift"
	  },
	  "service_type": "omniparcel_return",
	  "return_shipment": false,
	  "shipper_account": {
	    "id": "00000000-0000-0000-0000-000000000000"
	  },
	  "paper_size": "default",
	  "shipment": {
	    "parcels": [
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "width": 20,
	          "height": 30,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "item_id": "13131313",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "USD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      },
	      {
	        "box_type": "custom",
	        "weight": {
	          "value": 1.2,
	          "unit": "kg"
	        },
	        "dimension": {
	          "width": 20,
	          "height": 30,
	          "depth": 40,
	          "unit": "cm"
	        },
	        "items": [
	          {
	            "description": "Food Bar",
	            "origin_country": "AUS",
	            "quantity": 2,
	            "price": {
	              "amount": 50,
	              "currency": "USD"
	            },
	            "weight": {
	              "value": 0.6,
	              "unit": "kg"
	            },
	            "sku": "Epic_Food_Bar"
	          }
	        ]
	      }
	    ],
	    "ship_from": {
	      "contact_name": "Duncan",
	      "company_name": "Hicom Glenmarie",
	      "street1": "long long ago",
	      "country": "AUS",
	      "phone": "1-403-504-5496",
	      "email": "test@test.com",
	      "state": "New South Wales",
	      "city": "GLENWOOD",
	      "type": "business",
	      "postal_code": "2768"
	    },
	    "ship_to": {
	      "contact_name": "Panda",
	      "company_name": "Hicom Glenmarie ",
	      "street1": "australia city",
	      "country": "AUS",
	      "phone": "1-403-504-5496",
	      "email": "test2@panda.com",
	      "type": "residential",
	      "postal_code": "2190",
	      "city": "Chullora",
	      "state": "NSW"
	    }
	  },
	  "billing": {
	    "paid_by": "shipper",
	    "method": {
	      "account_number": "12344",
	      "type": "account"
	    }
	  },
	  "async": false,
	  "is_document": false,
	  "references": [
	    "950000002"
	  ]
	}
	'''
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('POST', url, data=payload, headers=headers)
	
	print(response.text)


	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/labels')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Post.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	request.body = '{"customs":{"billing":{"paid_by":"recipient","method":{"account_number":"12345","type":"account"}},"purpose":"gift"},"service_type":"omniparcel_return","return_shipment":false,"shipper_account":{"id":"00000000-0000-0000-0000-000000000000"},"paper_size":"default","shipment":{"parcels":[{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","item_id":"13131313","quantity":2,"price":{"amount":50,"currency":"USD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]},{"box_type":"custom","weight":{"value":1.2,"unit":"kg"},"dimension":{"width":20,"height":30,"depth":40,"unit":"cm"},"items":[{"description":"Food Bar","origin_country":"AUS","quantity":2,"price":{"amount":50,"currency":"USD"},"weight":{"value":0.6,"unit":"kg"},"sku":"Epic_Food_Bar"}]}],"ship_from":{"contact_name":"Duncan","company_name":"Hicom Glenmarie","street1":"long long ago","country":"AUS","phone":"1-403-504-5496","email":"test@test.com","state":"New South Wales","city":"GLENWOOD","type":"business","postal_code":"2768"},"ship_to":{"contact_name":"Panda","company_name":"Hicom Glenmarie ","street1":"australia city","country":"AUS","phone":"1-403-504-5496","email":"test2@panda.com","type":"residential","postal_code":"2190","city":"Chullora","state":"NSW"}},"billing":{"paid_by":"shipper","method":{"account_number":"12344","type":"account"}},"async":false,"is_document":false,"references":["950000002"]}'
	
	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: `omniparcel_forward`,`omniparcel_return`.

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "269f17ce-446b-4bd2-b072-f07a94793a40",
	    "status": "created",
	    "ship_date": "2019-07-27",
	    "created_at": "2019-07-27T03:42:51+00:00",
	    "updated_at": "2019-07-27T03:42:55+00:00",
	    "tracking_numbers": [
	      "4WD0052575"
	    ],
	    "files": {
	      "label": {
	        "paper_size": "a4",
	        "url": "https://sandbox-download.postmen.com/label/2019-07-27/00000000-0000-0000-0000-000000000000-0000000000000000.pdf",
	        "file_type": "pdf"
	      },
	      "invoice": null,
	      "customs_declaration": null,
	      "manifest": null
	    },
	    "rate": {
	      "shipper_account": {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "slug": "omniparcel",
	        "description": "omniparcel"
	      },
	      "service_type": "omniparcel_return",
	      "service_name": "Air Tracked",
	      "pickup_deadline": null,
	      "booking_cut_off": null,
	      "delivery_date": null,
	      "transit_time": null,
	      "error_message": null,
	      "info_message": null,
	      "charge_weight": {
	        "value": 2.4,
	        "unit": "kg"
	      },
	      "total_charge": {
	        "amount": 167.48,
	        "currency": "HKD"
	      },
	      "detailed_charges": []
	    }
	  }
	}

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": "269f17ce-446b-4bd2-b072-f07a94793a40",
	    "status": "created",
	    "ship_date": "2019-07-27",
	    "created_at": "2019-07-27T03:42:51+00:00",
	    "updated_at": "2019-07-27T03:42:55+00:00",
	    "tracking_numbers": [
	      "4WD0052575"
	    ],
	    "files": {
	      "label": {
	        "paper_size": "a4",
	        "url": "https://sandbox-download.postmen.com/label/2019-07-27/00000000-0000-0000-0000-000000000000-0000000000000000.pdf",
	        "file_type": "pdf"
	      },
	      "invoice": null,
	      "customs_declaration": null,
	      "manifest": null
	    },
	    "rate": {
	      "shipper_account": {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "slug": "omniparcel",
	        "description": "omniparcel"
	      },
	      "service_type": "omniparcel_tracked",
	      "service_name": "Air Tracked",
	      "pickup_deadline": null,
	      "booking_cut_off": null,
	      "delivery_date": null,
	      "transit_time": null,
	      "error_message": null,
	      "info_message": null,
	      "charge_weight": {
	        "value": 2.4,
	        "unit": "kg"
	      },
	      "total_charge": {
	        "amount": 167.48,
	        "currency": "HKD"
	      },
	      "detailed_charges": []
	    }
	  }
	}

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 (default: 24hrs ago)
`created_at_max`	string	End date and time of the record created (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": 2,
	    "created_at_min": "2019-07-27T08:49:15+00:00",
	    "created_at_max": "2019-07-27T08: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-07-27/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/invoice/2019-07-27/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
	            "file_type": "pdf"
	          },
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "rate": {
	          "charge_weight": {
	            "value": 14.5,
	            "unit": "kg"
	          },
	          "total_charge": {
	            "amount": 1168.06,
	            "currency": "HKD"
	          },
	          "shipper_account": {
	            "id": "00000000-0000-0000-0000-000000000000",
	            "slug": "omniparcel",
	            "description": "omniparcel"
	          },
	          "service_type": "omniparcel_return",
	          "service_name": "Air Tracked",
	          "pickup_deadline": null,
	          "booking_cut_off": null,
	          "delivery_date": null,
	          "transit_time": null,
	          "detailed_charges": [],
	          "error_message": null,
	          "info_message": null
	        },
	        "created_at": "2019-07-27T08:48:31+00:00",
	        "updated_at": "2019-07-27T08:48:35+00:00"
	      },
	      {
	        "id": "de57ca7e-0ca2-4bd9-8e25-cd9502dc66ed",
	        "status": "created",
	        "tracking_numbers": [
	          "8149526918288889"
	        ],
	        "files": {
	          "label": {
	            "paper_size": "4x6",
	            "url": "https://sandbox-download.postmen.com/label/2019-07-27/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/invoice/2019-07-27/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
	            "file_type": "pdf"
	          },
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "rate": {
	          "charge_weight": {
	            "value": 2,
	            "unit": "kg"
	          },
	          "total_charge": null,
	          "shipper_account": {
	            "id": "00000000-0000-0000-0000-000000000000",
	            "slug": "omniparcel",
	            "description": "omniparcel"
	          },
	          "service_type": "omniparcel_return",
	          "service_name": "Air Tracked",
	          "pickup_deadline": null,
	          "booking_cut_off": null,
	          "delivery_date": null,
	          "transit_time": null,
	          "detailed_charges": [],
	          "error_message": null,
	          "info_message": "No rate quotes returned from carrier."
	        },
	        "created_at": "2019-07-27T08:47:20+00:00",
	        "updated_at": "2019-07-27T08:47:22+00:00"
	      },
	      {
	        "id": "72393fe3-be8e-4a7a-8434-1f0b5b56c09e",
	        "status": "cancelled",
	        "tracking_numbers": [
	          "0470110200793101997414"
	        ],
	        "files": {
	          "label": {
	            "paper_size": "4x6",
	            "url": "https://sandbox-download.postmen.com/label/2019-07-27/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": {
	            "paper_size": "a4",
	            "url": "https://sandbox-download.postmen.com/invoice/2019-07-27/00000000-0000-0000-0000-000000000000-1441785264309885.pdf",
	            "file_type": "pdf"
	          },
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "rate": {
	          "charge_weight": null,
	          "total_charge": {
	            "amount": 16.3,
	            "currency": "USD"
	          },
	          "shipper_account": {
	            "id": "00000000-0000-0000-0000-000000000000",
	            "slug": "omniparcel",
	            "description": "Air Tracked"
	          },
	          "service_type": "omniparcel_return",
	          "service_name": "Air Tracked",
	          "pickup_deadline": null,
	          "booking_cut_off": null,
	          "delivery_date": null,
	          "transit_time": 1,
	          "detailed_charges": [],
	          "error_message": null,
	          "info_message": null
	        },
	        "created_at": "2019-07-27T08:46:56+00:00",
	        "updated_at": "2019-07-27T08:47:02+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: `omniparcel`.
`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


	{
	  "slug": "omniparcel",
	  "description": "My Shipper Account",
	  "timezone": "Asia/Hong_Kong",
	  "credentials": {
	    "access_key": "******",
	    "currency": "USD"
	  },
	  "address": {
	    "country": "HKG",
	    "contact_name": "Sir Foo",
	    "phone": "11111111",
	    "fax": "+1 206-654-3100",
	    "email": "foo@foo.com",
	    "company_name": "Foo Store",
	    "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
	    "street2": "18 Cheung Shun Street, Lai Chi Kok",
	    "city": "Lai Chi Kok",
	    "type": "business",
	    "postal_code": null,
	    "state": null,
	    "street3": null,
	    "tax_id": null
	  }
	}


	curl --request POST \
	    --url https://sandbox-api.postmen.com/v3/shipper-accounts \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"slug":"omniparcel","description":"My Shipper Account","timezone":"Asia/Hong_Kong","credentials":{"access_key":"******","currency":"USD"},"address":{"country":"HKG","contact_name":"Sir Foo","phone":"11111111","fax":"+1 206-654-3100","email":"foo@foo.com","company_name":"Foo Store","street1":"Workshop A, 10/F, Wah Shing Industrial Building","street2":"18 Cheung Shun Street, Lai Chi Kok","city":"Lai Chi Kok","type":"business","postal_code":null,"state":null,"street3":null,"tax_id":null}}'


	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/shipper-accounts");
	        string json = "{\"slug\":\"omniparcel\",\"description\":\"My Shipper Account\",\"timezone\":\"Asia/Hong_Kong\",\"credentials\":{\"access_key\":\"******\",\"currency\":\"USD\"},\"address\":{\"country\":\"HKG\",\"contact_name\":\"Sir Foo\",\"phone\":\"11111111\",\"fax\":\"+1 206-654-3100\",\"email\":\"foo@foo.com\",\"company_name\":\"Foo Store\",\"street1\":\"Workshop A, 10/F, Wah Shing Industrial Building\",\"street2\":\"18 Cheung Shun Street, Lai Chi Kok\",\"city\":\"Lai Chi Kok\",\"type\":\"business\",\"postal_code\":null,\"state\":null,\"street3\":null,\"tax_id\":null}}";
	
	        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, "{\"slug\":\"omniparcel\",\"description\":\"My Shipper Account\",\"timezone\":\"Asia/Hong_Kong\",\"credentials\":{\"access_key\":\"******\",\"currency\":\"USD\"},\"address\":{\"country\":\"HKG\",\"contact_name\":\"Sir Foo\",\"phone\":\"11111111\",\"fax\":\"+1 206-654-3100\",\"email\":\"foo@foo.com\",\"company_name\":\"Foo Store\",\"street1\":\"Workshop A, 10/F, Wah Shing Industrial Building\",\"street2\":\"18 Cheung Shun Street, Lai Chi Kok\",\"city\":\"Lai Chi Kok\",\"type\":\"business\",\"postal_code\":null,\"state\":null,\"street3\":null,\"tax_id\":null}}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/shipper-accounts")
	            .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/shipper-accounts',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"slug":"omniparcel","description":"My Shipper Account","timezone":"Asia/Hong_Kong","credentials":{"access_key":"******","currency":"USD"},"address":{"country":"HKG","contact_name":"Sir Foo","phone":"11111111","fax":"+1 206-654-3100","email":"foo@foo.com","company_name":"Foo Store","street1":"Workshop A, 10/F, Wah Shing Industrial Building","street2":"18 Cheung Shun Street, Lai Chi Kok","city":"Lai Chi Kok","type":"business","postal_code":null,"state":null,"street3":null,"tax_id":null}}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});


	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/shipper-accounts';
	    $method = 'POST';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"slug":"omniparcel","description":"My Shipper Account","timezone":"Asia/Hong_Kong","credentials":{"access_key":"******","currency":"USD"},"address":{"country":"HKG","contact_name":"Sir Foo","phone":"11111111","fax":"+1 206-654-3100","email":"foo@foo.com","company_name":"Foo Store","street1":"Workshop A, 10/F, Wah Shing Industrial Building","street2":"18 Cheung Shun Street, Lai Chi Kok","city":"Lai Chi Kok","type":"business","postal_code":null,"state":null,"street3":null,"tax_id":null}}';
	
	    $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/shipper-accounts'
	
	payload = '''
	{
	  "slug": "omniparcel",
	  "description": "My Shipper Account",
	  "timezone": "Asia/Hong_Kong",
	  "credentials": {
	    "access_key": "******",
	    "currency": "USD"
	  },
	  "address": {
	    "country": "HKG",
	    "contact_name": "Sir Foo",
	    "phone": "11111111",
	    "fax": "+1 206-654-3100",
	    "email": "foo@foo.com",
	    "company_name": "Foo Store",
	    "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
	    "street2": "18 Cheung Shun Street, Lai Chi Kok",
	    "city": "Lai Chi Kok",
	    "type": "business",
	    "postal_code": null,
	    "state": null,
	    "street3": null,
	    "tax_id": null
	  }
	}
	'''
	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/shipper-accounts')
	
	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 = '{"slug":"omniparcel","description":"My Shipper Account","timezone":"Asia/Hong_Kong","credentials":{"access_key":"******","currency":"USD"},"address":{"country":"HKG","contact_name":"Sir Foo","phone":"11111111","fax":"+1 206-654-3100","email":"foo@foo.com","company_name":"Foo Store","street1":"Workshop A, 10/F, Wah Shing Industrial Building","street2":"18 Cheung Shun Street, Lai Chi Kok","city":"Lai Chi Kok","type":"business","postal_code":null,"state":null,"street3":null,"tax_id":null}}'
	
	response = http.request(request)
	puts response.read_body

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

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "00000000-0000-0000-0000-000000000000",
	    "description": "My Shipper Account",
	    "slug": "omniparcel",
	    "status": "enabled",
	    "timezone": "Asia/Hong_Kong",
	    "type": "user",
	    "created_at": "2016-02-12T10:30:50+00:00",
	    "updated_at": "2016-09-23T04:56:26+00:00",
	    "address": {
	      "country": "HKG",
	      "contact_name": "Sir Foo",
	      "phone": "11111111",
	      "fax": "+1 206-654-3100",
	      "email": "foo@foo.com",
	      "company_name": "Foo Store",
	      "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
	      "street2": "18 Cheung Shun Street, Lai Chi Kok",
	      "city": "Lai Chi Kok",
	      "type": "business",
	      "postal_code": null,
	      "state": null,
	      "street3": null,
	      "tax_id": null
	    }
	  }
	}

DELETE Delete a shipper account

Try it

/shipper-accounts/:id

Delete a shipper account

Request
Response

{}


	curl --request DELETE \
	    --url https://sandbox-api.postmen.com/v3/shipper-accounts/ \
	    --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/shipper-accounts/");
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "DELETE";
	        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/shipper-accounts/")
	            .delete()
	    		.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: 'DELETE',
	    url: 'https://sandbox-api.postmen.com/v3/shipper-accounts/',
	    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/shipper-accounts/';
	    $method = 'DELETE';
	    $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/shipper-accounts/'
	
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('DELETE', url, headers=headers)
	
	print(response.text)


	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/shipper-accounts/')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Delete.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	id of referring object

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "00000000-0000-0000-0000-000000000000"
	  }
	}

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

{}


	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/shipper-accounts \
	    --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/shipper-accounts");
	
	        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/shipper-accounts")
	            .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/shipper-accounts',
	    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/shipper-accounts';
	    $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/shipper-accounts'
	
	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/shipper-accounts')
	
	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`	string	Number of records per page
`shipper_accounts`	array of a shipper_account object	A shipper_account object

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "next_token": "1",
	    "limit": 30,
	    "shipper_accounts": [
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "royal-mail",
	        "slug": "royal-mail",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-08-25T08:48:46+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "USA",
	          "contact_name": "jesus",
	          "phone": null,
	          "fax": null,
	          "email": null,
	          "company_name": "jesus company",
	          "street1": "one street in the USA",
	          "street2": null,
	          "street3": null,
	          "city": "Los Angeles",
	          "state": "CA",
	          "postal_code": "90210",
	          "type": null,
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "will_not_delete",
	        "slug": "aramex",
	        "status": "enabled",
	        "timezone": "America/Vancouver",
	        "type": "user",
	        "created_at": "2016-07-29T10:37:18+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "JOR",
	          "contact_name": "Sir Foo",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "foo@foo.com",
	          "company_name": "Foo Store",
	          "street1": "100 MAIN ST",
	          "street2": "PO BOX 1022",
	          "street3": "SEATTLE WA 98104",
	          "city": "Seattle",
	          "state": "TX",
	          "postal_code": "77055",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "ups",
	        "slug": "ups",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-07-14T09:36:35+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "CHN",
	          "contact_name": "hello",
	          "phone": "0601997749",
	          "fax": null,
	          "email": "Tian.Yu@8example.com",
	          "company_name": "天俞",
	          "street1": "150 Kennedy Road",
	          "street2": "Flat 25, 12/F, Acacia Building",
	          "street3": null,
	          "city": "Wan Chai",
	          "state": null,
	          "postal_code": "000852",
	          "type": "business",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "Bring sandbox",
	        "slug": "bring",
	        "status": "enabled",
	        "timezone": "Europe/Amsterdam",
	        "type": "user",
	        "created_at": "2016-07-12T08:57:03+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "NOR",
	          "contact_name": "Sir Foo",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "edward+mybring@aftership.com",
	          "company_name": "Demo Parcel Norway Customer",
	          "street1": "100 MAIN ST",
	          "street2": "PO BOX 1022",
	          "street3": "SEATTLE WA 98104",
	          "city": "Seattle",
	          "state": "TX",
	          "postal_code": "7600",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "Bring sandbox",
	        "slug": "bring",
	        "status": "enabled",
	        "timezone": "Europe/Amsterdam",
	        "type": "user",
	        "created_at": "2016-07-12T08:56:54+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "NOR",
	          "contact_name": "Sir Foo",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "edward+mybring@aftership.com",
	          "company_name": "Demo Parcel Norway Customer",
	          "street1": "100 MAIN ST",
	          "street2": "PO BOX 1022",
	          "street3": "SEATTLE WA 98104",
	          "city": "Seattle",
	          "state": "TX",
	          "postal_code": "7600",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "dpd-uk",
	        "slug": "dpd-uk",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-06-30T05:02:52+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "USA",
	          "contact_name": "jesus",
	          "phone": null,
	          "fax": null,
	          "email": null,
	          "company_name": "jesus",
	          "street1": "one street in the USA",
	          "street2": null,
	          "street3": null,
	          "city": "Los Angeles",
	          "state": "CA",
	          "postal_code": "90210",
	          "type": null,
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "fedex-smartpost",
	        "slug": "fedex-smartpost",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-06-29T08:53:44+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "USA",
	          "contact_name": "Sir Foo",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "foo@foo.com",
	          "company_name": "Foo Store",
	          "street1": "100 MAIN ST",
	          "street2": "PO BOX 1022",
	          "street3": "SEATTLE WA 98104",
	          "city": "Seattle",
	          "state": "TX",
	          "postal_code": "77055",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "bluedart",
	        "slug": "bluedart",
	        "status": "enabled",
	        "timezone": "Asia/Kolkata",
	        "type": "user",
	        "created_at": "2016-06-27T09:04:41+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "HKG",
	          "contact_name": "Buckinghamshire Livingstone West",
	          "phone": null,
	          "fax": null,
	          "email": "buckstonewest@royalfamily.com",
	          "company_name": "The Royal Family",
	          "street1": "No.1 Northwesthamsexshirecaster Boulevard",
	          "street2": "Turing Test Town",
	          "street3": null,
	          "city": "Thisisalongnameingshumshire",
	          "state": "Sussex",
	          "postal_code": "560084",
	          "type": "residential",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "dpd-uk",
	        "slug": "dpd-uk",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-06-24T05:59:57+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "USA",
	          "contact_name": "jesus",
	          "phone": null,
	          "fax": null,
	          "email": null,
	          "company_name": "asas",
	          "street1": "one street in the USA",
	          "street2": null,
	          "street3": null,
	          "city": "Los Angeles",
	          "state": "NY",
	          "postal_code": "90210",
	          "type": null,
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "gls-ireland",
	        "slug": "gls-ireland",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-06-23T09:47:59+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "BEL",
	          "contact_name": "Buckinghamshire Livingstone West",
	          "phone": null,
	          "fax": null,
	          "email": "buckstonewest@royalfamily.com",
	          "company_name": "The Royal Family",
	          "street1": "Elsensesteenweg 21",
	          "street2": null,
	          "street3": null,
	          "city": "Brussel",
	          "state": "Abcde",
	          "postal_code": "1050",
	          "type": "residential",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "sf-express",
	        "slug": "sf-express",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-06-23T09:43:37+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "HKG",
	          "contact_name": "Sir Pudgu",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "foo@foo.com",
	          "company_name": "Foo Store",
	          "street1": "Tsuen Wan",
	          "street2": null,
	          "street3": null,
	          "city": "Mississauga",
	          "state": null,
	          "postal_code": "L4W5M8",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "ups-mi",
	        "slug": "ups-mi",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-06-23T09:29:56+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "HKG",
	          "contact_name": "Elmira Zulauf",
	          "phone": "2433-1212",
	          "fax": null,
	          "email": null,
	          "company_name": "Kemmer-Gerhold",
	          "street1": "662 Flatley Manors",
	          "street2": null,
	          "street3": null,
	          "city": "Hong Kong",
	          "state": null,
	          "postal_code": null,
	          "type": "business",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "purolator",
	        "slug": "purolator",
	        "status": "enabled",
	        "timezone": "America/Vancouver",
	        "type": "user",
	        "created_at": "2016-06-17T08:06:05+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "CAN",
	          "contact_name": "Sir Foo",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "foo@foo.com",
	          "company_name": "Foo Store",
	          "street1": "Tsuen Wan",
	          "street2": null,
	          "street3": null,
	          "city": "Mississauga",
	          "state": "BC",
	          "postal_code": "L4W 5M8",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "ups",
	        "slug": "ups",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-06-16T09:02:27+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "HKG",
	          "contact_name": "Sir Foo",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "foo@foo.com",
	          "company_name": "Foo Store",
	          "street1": "Tsuen Wan",
	          "street2": null,
	          "street3": null,
	          "city": "Hong Kong",
	          "state": null,
	          "postal_code": "77055",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "canpar-01",
	        "slug": "canpar",
	        "status": "enabled",
	        "timezone": "Canada/Central",
	        "type": "user",
	        "created_at": "2016-06-14T07:17:23+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "CAN",
	          "contact_name": "Ada",
	          "phone": "+16476942677",
	          "fax": null,
	          "email": "ada@seller.com",
	          "company_name": "Testing Company",
	          "street1": "330-340 W 34th St",
	          "street2": "Can Ada stop, Canada",
	          "street3": null,
	          "city": "Central",
	          "state": "AB",
	          "postal_code": "T5A 1H1",
	          "type": "residential",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "bring 2",
	        "slug": "bring",
	        "status": "enabled",
	        "timezone": "Africa/Abidjan",
	        "type": "user",
	        "created_at": "2016-06-08T11:40:45+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "SWE",
	          "contact_name": "qqqqq",
	          "phone": null,
	          "fax": null,
	          "email": null,
	          "company_name": "wwww",
	          "street1": "eee",
	          "street2": null,
	          "street3": null,
	          "city": null,
	          "state": null,
	          "postal_code": null,
	          "type": "business",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "fedex",
	        "slug": "fedex",
	        "status": "enabled",
	        "timezone": "Asia/Kolkata",
	        "type": "user",
	        "created_at": "2016-06-08T10:13:18+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "IND",
	          "contact_name": "Sir Foo",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "edward@aftership.com",
	          "company_name": "Demo Parcel Norway Customer",
	          "street1": "100 MAIN ST",
	          "street2": "PO BOX 1022",
	          "street3": "SEATTLE WA 98104",
	          "city": "Bangalore",
	          "state": "Karnataka",
	          "postal_code": "560034",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "bondscouriers",
	        "slug": "bondscouriers",
	        "status": "enabled",
	        "timezone": "Australia/Brisbane",
	        "type": "user",
	        "created_at": "2016-06-07T08:50:05+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "AUS",
	          "contact_name": "Buckinghamshire Livingstone West",
	          "phone": null,
	          "fax": null,
	          "email": "buckstonewest@royalfamily.com",
	          "company_name": "SICAB PTY LTD",
	          "street1": "Level 2, Suite 4, 55 Norton St.",
	          "street2": null,
	          "street3": null,
	          "city": "Leichhardt",
	          "state": "NSW",
	          "postal_code": "1050",
	          "type": "residential",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "bluedart",
	        "slug": "courex",
	        "status": "enabled",
	        "timezone": "Asia/Singapore",
	        "type": "user",
	        "created_at": "2016-06-07T08:48:51+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "SGP",
	          "contact_name": "Buckinghamshire Livingstone West",
	          "phone": null,
	          "fax": null,
	          "email": "buckstonewest@royalfamily.com",
	          "company_name": "The Royal Family",
	          "street1": "No.1 Northwesthamsexshirecaster Boulevard",
	          "street2": "Turing Test Town",
	          "street3": null,
	          "city": "Thisisalongnameingshumshire",
	          "state": "Sussex",
	          "postal_code": "560084",
	          "type": "residential",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "delhivery description",
	        "slug": "delhivery",
	        "status": "enabled",
	        "timezone": "Asia/Kolkata",
	        "type": "user",
	        "created_at": "2016-05-13T10:09:43+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "IND",
	          "contact_name": "Buckinghamshire Livingstone West",
	          "phone": null,
	          "fax": null,
	          "email": "buckstonewest@delhivery.com",
	          "company_name": "The Royal Family",
	          "street1": "113 Barthal, Dundahera",
	          "street2": null,
	          "street3": null,
	          "city": "New Delhi",
	          "state": "Delhi",
	          "postal_code": "110070",
	          "type": "residential",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "endicia",
	        "slug": "endicia",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-05-13T10:08:18+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "USA",
	          "contact_name": "jesus",
	          "phone": null,
	          "fax": null,
	          "email": null,
	          "company_name": "My Company",
	          "street1": "one street in the USA",
	          "street2": null,
	          "street3": null,
	          "city": "Los Angeles",
	          "state": "CA",
	          "postal_code": "90210",
	          "type": null,
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "Bring sandbox",
	        "slug": "bring",
	        "status": "enabled",
	        "timezone": "Europe/Amsterdam",
	        "type": "user",
	        "created_at": "2016-05-10T09:42:23+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "NOR",
	          "contact_name": "Sir Foo",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "edward+mybring@aftership.com",
	          "company_name": "Demo Parcel Norway Customer",
	          "street1": "100 MAIN ST",
	          "street2": "PO BOX 1022",
	          "street3": "SEATTLE WA 98104",
	          "city": "Seattle",
	          "state": "TX",
	          "postal_code": "7600",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "DHL Express",
	        "slug": "dhl",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-04-28T11:00:37+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "NLD",
	          "contact_name": "Hombre Amsterdam",
	          "phone": "+31 (0)20 683 8558",
	          "fax": null,
	          "email": "support@hombreamsterdam.com",
	          "company_name": "Hombre Amsterdam",
	          "street1": "Jan Evertsenstraat 70",
	          "street2": null,
	          "street3": null,
	          "city": "Amsterdam",
	          "state": null,
	          "postal_code": "1056 EE",
	          "type": "business",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "dhl-global-mail-asia account",
	        "slug": "dhl-global-mail-asia",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-04-06T09:07:25+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "HKG",
	          "contact_name": "Buyer Name",
	          "phone": "+85221234568",
	          "fax": null,
	          "email": "support@seller.com",
	          "company_name": "Testing Company",
	          "street1": "330-340 W 34th St",
	          "street2": "Super smart building, Hong Kong",
	          "street3": null,
	          "city": "Hong Kong",
	          "state": null,
	          "postal_code": null,
	          "type": "residential",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "fedex-for-cod-india",
	        "slug": "fedex",
	        "status": "enabled",
	        "timezone": "Asia/Kolkata",
	        "type": "user",
	        "created_at": "2016-03-10T07:09:51+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "IND",
	          "contact_name": "Sir Foo",
	          "phone": "+1 206-654-3100",
	          "fax": "+1 206-654-3100",
	          "email": "edward@aftership.com",
	          "company_name": "Demo Parcel Norway Customer",
	          "street1": "100 MAIN ST",
	          "street2": "PO BOX 1022",
	          "street3": "SEATTLE WA 98104",
	          "city": "Bangalore",
	          "state": "Karnataka",
	          "postal_code": "560034",
	          "type": "business",
	          "tax_id": "911-70-1234"
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "will_not_delete",
	        "slug": "fedex",
	        "status": "enabled",
	        "timezone": "America/Vancouver",
	        "type": "user",
	        "created_at": "2016-03-07T09:44:47+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "CAN",
	          "contact_name": "Ada",
	          "phone": "+16476942677",
	          "fax": null,
	          "email": "ada@seller.com",
	          "company_name": "Testing Company",
	          "street1": "330-340 W 34th St",
	          "street2": "Can Ada stop, Canada",
	          "street3": null,
	          "city": "Central",
	          "state": "AB",
	          "postal_code": "T5A 1H1",
	          "type": "residential",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "bpost",
	        "slug": "bpost",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-02-17T10:28:52+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "BEL",
	          "contact_name": "Buckinghamshire Livingstone West",
	          "phone": null,
	          "fax": null,
	          "email": "buckstonewest@royalfamily.com",
	          "company_name": "The Royal Family",
	          "street1": "Elsensesteenweg 21",
	          "street2": null,
	          "street3": null,
	          "city": "Brussel",
	          "state": "Abcde",
	          "postal_code": "1050",
	          "type": "residential",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "tnt",
	        "slug": "tnt",
	        "status": "enabled",
	        "timezone": "Asia/Hong_Kong",
	        "type": "user",
	        "created_at": "2016-02-12T10:30:50+00:00",
	        "updated_at": "2016-09-23T04:56:26+00:00",
	        "address": {
	          "country": "HKG",
	          "contact_name": "Sir Foo",
	          "phone": "11111111",
	          "fax": "+1 206-654-3100",
	          "email": "foo@foo.com",
	          "company_name": "Foo Store",
	          "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
	          "street2": "18 Cheung Shun Street, Lai Chi Kok",
	          "street3": null,
	          "city": "Lai Chi Kok",
	          "state": null,
	          "postal_code": null,
	          "type": "business",
	          "tax_id": null
	        }
	      },
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "description": "myhermes-uk",
	        "slug": "hermes",
	        "status": "enabled",
	        "timezone": "Europe/London",
	        "type": "user",
	        "created_at": "2016-02-12T10:28:31+00:00",
	        "updated_at": "2016-09-23T04:56:25+00:00",
	        "address": {
	          "country": "GBR",
	          "contact_name": "Buckinghamshire Livingstone West",
	          "phone": null,
	          "fax": null,
	          "email": "buckstonewest@royalfamily.com",
	          "company_name": "The Royal Family",
	          "street1": "No.1 Northwesthamsexshirecaster Boulevard",
	          "street2": "Turing Test Town",
	          "street3": null,
	          "city": "Thisisalongnameingshumshire",
	          "state": "Sussex",
	          "postal_code": "B17 0WD",
	          "type": "residential",
	          "tax_id": null
	        }
	      }
	    ]
	  }
	}

GET Retrieve a shipper account

Try it

/shipper-accounts/:id

Retrieve a shipper account

Request
Response

{}


	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000 \
	    --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/shipper-accounts/00000000-0000-0000-0000-000000000000");
	
	        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/shipper-accounts/00000000-0000-0000-0000-000000000000")
	            .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/shipper-accounts/00000000-0000-0000-0000-000000000000',
	    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/shipper-accounts/00000000-0000-0000-0000-000000000000';
	    $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/shipper-accounts/00000000-0000-0000-0000-000000000000'
	
	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/shipper-accounts/00000000-0000-0000-0000-000000000000')
	
	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	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

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "00000000-0000-0000-0000-000000000000",
	    "description": "My Shipper Account",
	    "slug": "omniparcel",
	    "status": "enabled",
	    "timezone": "Asia/Hong_Kong",
	    "type": "user",
	    "created_at": "2016-02-12T10:30:50+00:00",
	    "updated_at": "2016-09-23T04:56:26+00:00",
	    "address": {
	      "country": "HKG",
	      "contact_name": "Sir Foo",
	      "phone": "11111111",
	      "fax": "+1 206-654-3100",
	      "email": "foo@foo.com",
	      "company_name": "Foo Store",
	      "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
	      "street2": "18 Cheung Shun Street, Lai Chi Kok",
	      "street3": null,
	      "city": "Lai Chi Kok",
	      "state": null,
	      "postal_code": null,
	      "type": "business",
	      "tax_id": null
	    }
	  }
	}

PUT Update a shipper account credentials

Try it

/shipper-accounts/:id/credentials

Update a shipper account credentials

Request
Response

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


	{
	  "access_key": "******",
	  "currency": "USD"
	}


	curl --request PUT \
	    --url https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/credentials \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"access_key":"******","currency":"USD"}'


	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/shipper-accounts/00000000-0000-0000-0000-000000000000/credentials");
	        string json = "{\"access_key\":\"******\",\"currency\":\"USD\"}";
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "PUT";
	        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, "{\"access_key\":\"******\",\"currency\":\"USD\"}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/credentials")
	            .put(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: 'PUT',
	    url: 'https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/credentials',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"access_key":"******","currency":"USD"}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});


	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/credentials';
	    $method = 'PUT';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"access_key":"******","currency":"USD"}';
	
	    $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/shipper-accounts/00000000-0000-0000-0000-000000000000/credentials'
	
	payload = '''
	{
	  "access_key": "******",
	  "currency": "USD"
	}
	'''
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('PUT', url, data=payload, headers=headers)
	
	print(response.text)


	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/credentials')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Put.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	request.body = '{"access_key":"******","currency":"USD"}'
	
	response = http.request(request)
	puts response.read_body

Name	Type	Description
`id`	string	id of referring object

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "00000000-0000-0000-0000-000000000000"
	  }
	}

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


	{
	  "description": "My Shipper Account",
	  "timezone": "Asia/Hong_Kong",
	  "address": {
	    "country": "HKG",
	    "contact_name": "Sir Foo",
	    "phone": "11111111",
	    "fax": "+1 206-654-3100",
	    "email": "foo@foo.com",
	    "company_name": "Foo Store",
	    "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
	    "street2": "18 Cheung Shun Street, Lai Chi Kok",
	    "city": "Lai Chi Kok",
	    "type": "business",
	    "street3": null,
	    "state": null,
	    "postal_code": null,
	    "tax_id": null
	  }
	}


	curl --request PUT \
	    --url https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/info \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"description":"My Shipper Account","timezone":"Asia/Hong_Kong","address":{"country":"HKG","contact_name":"Sir Foo","phone":"11111111","fax":"+1 206-654-3100","email":"foo@foo.com","company_name":"Foo Store","street1":"Workshop A, 10/F, Wah Shing Industrial Building","street2":"18 Cheung Shun Street, Lai Chi Kok","city":"Lai Chi Kok","type":"business","street3":null,"state":null,"postal_code":null,"tax_id":null}}'


	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/shipper-accounts/00000000-0000-0000-0000-000000000000/info");
	        string json = "{\"description\":\"My Shipper Account\",\"timezone\":\"Asia/Hong_Kong\",\"address\":{\"country\":\"HKG\",\"contact_name\":\"Sir Foo\",\"phone\":\"11111111\",\"fax\":\"+1 206-654-3100\",\"email\":\"foo@foo.com\",\"company_name\":\"Foo Store\",\"street1\":\"Workshop A, 10/F, Wah Shing Industrial Building\",\"street2\":\"18 Cheung Shun Street, Lai Chi Kok\",\"city\":\"Lai Chi Kok\",\"type\":\"business\",\"street3\":null,\"state\":null,\"postal_code\":null,\"tax_id\":null}}";
	
	        httpWebRequest.ContentType = "application/json";
	        httpWebRequest.Method = "PUT";
	        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, "{\"description\":\"My Shipper Account\",\"timezone\":\"Asia/Hong_Kong\",\"address\":{\"country\":\"HKG\",\"contact_name\":\"Sir Foo\",\"phone\":\"11111111\",\"fax\":\"+1 206-654-3100\",\"email\":\"foo@foo.com\",\"company_name\":\"Foo Store\",\"street1\":\"Workshop A, 10/F, Wah Shing Industrial Building\",\"street2\":\"18 Cheung Shun Street, Lai Chi Kok\",\"city\":\"Lai Chi Kok\",\"type\":\"business\",\"street3\":null,\"state\":null,\"postal_code\":null,\"tax_id\":null}}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/info")
	            .put(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: 'PUT',
	    url: 'https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/info',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"description":"My Shipper Account","timezone":"Asia/Hong_Kong","address":{"country":"HKG","contact_name":"Sir Foo","phone":"11111111","fax":"+1 206-654-3100","email":"foo@foo.com","company_name":"Foo Store","street1":"Workshop A, 10/F, Wah Shing Industrial Building","street2":"18 Cheung Shun Street, Lai Chi Kok","city":"Lai Chi Kok","type":"business","street3":null,"state":null,"postal_code":null,"tax_id":null}}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});


	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/info';
	    $method = 'PUT';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"description":"My Shipper Account","timezone":"Asia/Hong_Kong","address":{"country":"HKG","contact_name":"Sir Foo","phone":"11111111","fax":"+1 206-654-3100","email":"foo@foo.com","company_name":"Foo Store","street1":"Workshop A, 10/F, Wah Shing Industrial Building","street2":"18 Cheung Shun Street, Lai Chi Kok","city":"Lai Chi Kok","type":"business","street3":null,"state":null,"postal_code":null,"tax_id":null}}';
	
	    $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/shipper-accounts/00000000-0000-0000-0000-000000000000/info'
	
	payload = '''
	{
	  "description": "My Shipper Account",
	  "timezone": "Asia/Hong_Kong",
	  "address": {
	    "country": "HKG",
	    "contact_name": "Sir Foo",
	    "phone": "11111111",
	    "fax": "+1 206-654-3100",
	    "email": "foo@foo.com",
	    "company_name": "Foo Store",
	    "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
	    "street2": "18 Cheung Shun Street, Lai Chi Kok",
	    "city": "Lai Chi Kok",
	    "type": "business",
	    "street3": null,
	    "state": null,
	    "postal_code": null,
	    "tax_id": null
	  }
	}
	'''
	headers = {
	    'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
	    'content-type': 'application/json'
	}
	
	response = requests.request('PUT', url, data=payload, headers=headers)
	
	print(response.text)


	require 'uri'
	require 'net/http'
	
	url = URI('https://sandbox-api.postmen.com/v3/shipper-accounts/00000000-0000-0000-0000-000000000000/info')
	
	http = Net::HTTP.new(url.host, url.port)
	http.use_ssl = true
	
	request = Net::HTTP::Put.new(url)
	request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
	request['content-type'] = 'application/json'
	request.body = '{"description":"My Shipper Account","timezone":"Asia/Hong_Kong","address":{"country":"HKG","contact_name":"Sir Foo","phone":"11111111","fax":"+1 206-654-3100","email":"foo@foo.com","company_name":"Foo Store","street1":"Workshop A, 10/F, Wah Shing Industrial Building","street2":"18 Cheung Shun Street, Lai Chi Kok","city":"Lai Chi Kok","type":"business","street3":null,"state":null,"postal_code":null,"tax_id":null}}'
	
	response = http.request(request)
	puts response.read_body

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

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "00000000-0000-0000-0000-000000000000",
	    "description": "My Shipper Account",
	    "slug": "omniparcel",
	    "status": "enabled",
	    "timezone": "Asia/Hong_Kong",
	    "type": "user",
	    "created_at": "2016-02-12T10:30:50+00:00",
	    "updated_at": "2016-09-23T04:56:26+00:00",
	    "address": {
	      "country": "HKG",
	      "contact_name": "Sir Foo",
	      "phone": "11111111",
	      "fax": "+1 206-654-3100",
	      "email": "foo@foo.com",
	      "company_name": "Foo Store",
	      "street1": "Workshop A, 10/F, Wah Shing Industrial Building",
	      "street2": "18 Cheung Shun Street, Lai Chi Kok",
	      "city": "Lai Chi Kok",
	      "type": "business",
	      "street3": null,
	      "state": null,
	      "postal_code": null,
	      "tax_id": null
	    }
	  }
	}

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)


	{
	  "async": false,
	  "labels": [
	    {
	      "id": "10000000-0000-0000-0000-000000000000"
	    },
	    {
	      "id": "20000000-0000-0000-0000-000000000000"
	    },
	    {
	      "id": "30000000-0000-0000-0000-000000000000"
	    }
	  ]
	}


	curl --request POST \
	    --url https://sandbox-api.postmen.com/v3/bulk-downloads \
	    --header 'content-type: application/json' \
	    --header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
	    --data '{"async":false,"labels":[{"id":"10000000-0000-0000-0000-000000000000"},{"id":"20000000-0000-0000-0000-000000000000"},{"id":"30000000-0000-0000-0000-000000000000"}]}'


	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/bulk-downloads");
	        string json = "{\"async\":false,\"labels\":[{\"id\":\"10000000-0000-0000-0000-000000000000\"},{\"id\":\"20000000-0000-0000-0000-000000000000\"},{\"id\":\"30000000-0000-0000-0000-000000000000\"}]}";
	
	        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,\"labels\":[{\"id\":\"10000000-0000-0000-0000-000000000000\"},{\"id\":\"20000000-0000-0000-0000-000000000000\"},{\"id\":\"30000000-0000-0000-0000-000000000000\"}]}");
	
	    	Request request = new Request.Builder()
	    		.url("https://sandbox-api.postmen.com/v3/bulk-downloads")
	            .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/bulk-downloads',
	    headers: {
			'content-type': 'application/json',
	        'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
		},
	    body: '{"async":false,"labels":[{"id":"10000000-0000-0000-0000-000000000000"},{"id":"20000000-0000-0000-0000-000000000000"},{"id":"30000000-0000-0000-0000-000000000000"}]}'
	};
	
	request(options, function (error, response, body) {
	    if (error) throw new Error(error);
	    console.log(body);
	});


	<?php
	
	    $url = 'https://sandbox-api.postmen.com/v3/bulk-downloads';
	    $method = 'POST';
	    $headers = array(
	        "content-type: application/json",
	        "postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
	    );
	    $body = '{"async":false,"labels":[{"id":"10000000-0000-0000-0000-000000000000"},{"id":"20000000-0000-0000-0000-000000000000"},{"id":"30000000-0000-0000-0000-000000000000"}]}';
	
	    $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/bulk-downloads'
	
	payload = '''
	{
	  "async": false,
	  "labels": [
	    {
	      "id": "10000000-0000-0000-0000-000000000000"
	    },
	    {
	      "id": "20000000-0000-0000-0000-000000000000"
	    },
	    {
	      "id": "30000000-0000-0000-0000-000000000000"
	    }
	  ]
	}
	'''
	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/bulk-downloads')
	
	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,"labels":[{"id":"10000000-0000-0000-0000-000000000000"},{"id":"20000000-0000-0000-0000-000000000000"},{"id":"30000000-0000-0000-0000-000000000000"}]}'
	
	response = http.request(request)
	puts response.read_body

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

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "00000000-0000-0000-0000-000000000000",
	    "created_at": "2017-09-14T12:04:57+00:00",
	    "updated_at": "2017-09-14T12:04:58+00:00",
	    "status": "created",
	    "files": {
	      "label": {
	        "paper_size": "default",
	        "url": "https://sandbox-download.postmen.com/bulk-download/2017-09-14/00000000-0000-0000-0000-000000000000-0000000000000000.pdf",
	        "file_type": "pdf"
	      },
	      "invoice": null,
	      "customs_declaration": null,
	      "manifest": null
	    },
	    "labels": [
	      {
	        "id": "10000000-0000-0000-0000-000000000000"
	      },
	      {
	        "id": "20000000-0000-0000-0000-000000000000"
	      }
	    ],
	    "invalid_labels": [
	      {
	        "id": "30000000-0000-0000-0000-000000000000"
	      }
	    ]
	  }
	}

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 (default: 24hrs ago)
`created_at_max`	string	End date and time of the record created (default: NOW())
`next_token`	string	Next token

{}


	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/bulk-downloads \
	    --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/bulk-downloads");
	
	        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/bulk-downloads")
	            .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/bulk-downloads',
	    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/bulk-downloads';
	    $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/bulk-downloads'
	
	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/bulk-downloads')
	
	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
`bulk_downloads`	array of a bulk download object	A bulk download object

Response example

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "bulk_downloads": [
	      {
	        "id": "00000000-0000-0000-0000-000000000000",
	        "created_at": "2017-09-14T12:04:57+00:00",
	        "updated_at": "2017-09-14T12:04:58+00:00",
	        "status": "created",
	        "files": {
	          "label": {
	            "paper_size": "default",
	            "url": "https://sandbox-download.postmen.com/bulk-download/2017-09-14/00000000-0000-0000-0000-000000000000-0000000000000000.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": null,
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "labels": [
	          {
	            "id": "10000000-0000-0000-0000-000000000000"
	          },
	          {
	            "id": "20000000-0000-0000-0000-000000000000"
	          }
	        ],
	        "invalid_labels": [
	          {
	            "id": "30000000-0000-0000-0000-000000000000"
	          }
	        ]
	      },
	      {
	        "id": "11111111-1111-1111-1111-111111111111",
	        "created_at": "2017-09-14T12:04:57+00:00",
	        "updated_at": "2017-09-14T12:04:58+00:00",
	        "status": "created",
	        "files": {
	          "label": {
	            "paper_size": "default",
	            "url": "https://sandbox-download.postmen.com/bulk-download/2017-09-14/00000000-0000-0000-0000-000000000000-1111111111111111.pdf",
	            "file_type": "pdf"
	          },
	          "invoice": null,
	          "customs_declaration": null,
	          "manifest": null
	        },
	        "labels": [
	          {
	            "id": "10000000-0000-0000-0000-000000000000"
	          },
	          {
	            "id": "20000000-0000-0000-0000-000000000000"
	          }
	        ],
	        "invalid_labels": []
	      }
	    ]
	  }
	}

GET Retrieve a bulk download

Try it

/bulk-downloads/:id

Retrieve a bulk download

Request
Response

{}


	curl --request GET \
	    --url https://sandbox-api.postmen.com/v3/bulk-downloads/00000000-0000-0000-0000-000000000000 \
	    --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/bulk-downloads/00000000-0000-0000-0000-000000000000");
	
	        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/bulk-downloads/00000000-0000-0000-0000-000000000000")
	            .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/bulk-downloads/00000000-0000-0000-0000-000000000000',
	    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/bulk-downloads/00000000-0000-0000-0000-000000000000';
	    $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/bulk-downloads/00000000-0000-0000-0000-000000000000'
	
	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/bulk-downloads/00000000-0000-0000-0000-000000000000')
	
	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	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

{
	  "meta": {
	    "code": 200,
	    "message": "OK",
	    "details": []
	  },
	  "data": {
	    "id": "00000000-0000-0000-0000-000000000000",
	    "created_at": "2017-09-14T12:04:57+00:00",
	    "updated_at": "2017-09-14T12:04:58+00:00",
	    "status": "created",
	    "files": {
	      "label": {
	        "paper_size": "default",
	        "url": "https://sandbox-download.postmen.com/bulk-download/2017-09-14/00000000-0000-0000-0000-000000000000-0000000000000000.pdf",
	        "file_type": "pdf"
	      },
	      "invoice": null,
	      "customs_declaration": null,
	      "manifest": null
	    },
	    "labels": [
	      {
	        "id": "10000000-0000-0000-0000-000000000000"
	      },
	      {
	        "id": "20000000-0000-0000-0000-000000000000"
	      }
	    ],
	    "invalid_labels": [
	      {
	        "id": "30000000-0000-0000-0000-000000000000"
	      }
	    ]
	  }
	}

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

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

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

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`,`omniparcel_bag`,`omniparcel_carton`,`omniparcel_container`,`omniparcel_crate`,`omniparcel_envelope`,`omniparcel_pail`,`omniparcel_pallet`,`omniparcel_satchel`,`omniparcel_tube`.
`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
`weight` *	weight	weight 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`.
`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
`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
`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
`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: `4x8`,`a4`,`default`. (set to `"default"` if not provided)
`url` *	string	URL of the file
`file_type` *	string	File Type Accepts: `pdf`.

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
`contact_name` *	string	contact_name of address
`company_name` *	string	company_name of address
`street1` *	string	address_line1 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`.
`phone`	string	contact_phone of address
`fax`	string	fax_number of address
`email`	string	email 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
`paid_by` *	string	Accepts: `shipper`,`recipient`,`third_party`.
`method`	payment method - account	Payment Method - Account

Name	Type	Description
`number_of_copies`	integer	Minimum: 1 , Maximum: 4

Name	Type	Description
`type`	string	Detailed charges e.g. base, tax, fuel, discount etc.
`charge`	money	money object

Name	Type	Description
`width` *	number	width
`height` *	number	height
`depth` *	number	depth
`unit` *	string	unit Accepts: `cm`,`in`,`mm`,`m`,`ft`,`yd`.

Name	Type	Description
`username` *	string	username for ftp upload
`password` *	string	password for ftp upload

Name	Type	Description
`url` *	string	protocol://domain + port + path
`username` *	string	username for ftp upload
`password` *	string	password for ftp upload

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

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

Name	Type	Description
`number` *	string	Passport Number
`issue_date` *	string	Issue Date in YYYY-MM-DD

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

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

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.

Postmen API docs for OmniParcel

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

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

Billing

Customs

Shipment

Address

Parcel

Item

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 - Shipper Account

Customs Billing

Customs Declaration

Detailed Charges

Dimension

FTP

FTP

Invoice

Money

Passport

Payment Method - Account

Postmen error

Postmen meta

Rate type

Service Option - General

Ship From Address

Ship To Address

Shipper Account Credentials

Shipper Account Information

Signature

Weight

aes

no_eei

reference

return To Address

Box Type

Bulk Download Status

Country Code

Currency Code

Label Paper Size