Create a label
Name | Type | Description |
---|---|---|
service_type * | string | Service Types Accepts: omniparcel_domestic_express ,omniparcel_domestic_standard ,omniparcel_ecommerce_express_tracked ,omniparcel_ecommerce_standard_tracked ,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: 4x6 ,4x8 ,a4 ,default . (set to "default" if not provided) |
file_type | string | Label file type Accepts: pdf . (set to "pdf" if not provided) |
ship_date | string | Ship Date in YYYY-MM-DD, if not provided, will be today of the shipper account timezone |
service_options | array of service option - general | Service options |
is_document | boolean | If the shipment is document type. (set to false if not provided) |
invoice | invoice | Invoice object, used to describe invoice type. Optional. Commercial invoice will be generated if field is present in the request body, else not. |
references | array of strings | Reference numbers for a label |
billing | billing | Billing Object |
customs | customs | Customs Object |
order_number | string | A user-defined order number used to identify an order. |
{
"customs": {
"billing": {
"paid_by": "shipper",
"method": {
"account_number": "1473321",
"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": "Panda",
"company_name": "Hicom Glenmarie",
"street1": "long long ago",
"country": "AUS",
"phone": "1-403-504-5496",
"email": "test@panda.com",
"state": "New South Wales",
"city": "GLENWOOD",
"type": "business",
"postal_code": "2768"
},
"ship_to": {
"contact_name": "Duncan",
"company_name": "Hicom Glenmarie ",
"street1": "australia city",
"country": "AUS",
"phone": "1-403-504-5496",
"email": "test2@duncan.com",
"type": "residential",
"postal_code": "2190",
"city": "Chullora",
"state": "NSW"
}
},
"billing": {
"paid_by": "shipper",
"method": {
"account_number": "1473321",
"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":"shipper","method":{"account_number":"1473321","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":"Panda","company_name":"Hicom Glenmarie","street1":"long long ago","country":"AUS","phone":"1-403-504-5496","email":"test@panda.com","state":"New South Wales","city":"GLENWOOD","type":"business","postal_code":"2768"},"ship_to":{"contact_name":"Duncan","company_name":"Hicom Glenmarie ","street1":"australia city","country":"AUS","phone":"1-403-504-5496","email":"test2@duncan.com","type":"residential","postal_code":"2190","city":"Chullora","state":"NSW"}},"billing":{"paid_by":"shipper","method":{"account_number":"1473321","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\":\"shipper\",\"method\":{\"account_number\":\"1473321\",\"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\":\"Panda\",\"company_name\":\"Hicom Glenmarie\",\"street1\":\"long long ago\",\"country\":\"AUS\",\"phone\":\"1-403-504-5496\",\"email\":\"test@panda.com\",\"state\":\"New South Wales\",\"city\":\"GLENWOOD\",\"type\":\"business\",\"postal_code\":\"2768\"},\"ship_to\":{\"contact_name\":\"Duncan\",\"company_name\":\"Hicom Glenmarie \",\"street1\":\"australia city\",\"country\":\"AUS\",\"phone\":\"1-403-504-5496\",\"email\":\"test2@duncan.com\",\"type\":\"residential\",\"postal_code\":\"2190\",\"city\":\"Chullora\",\"state\":\"NSW\"}},\"billing\":{\"paid_by\":\"shipper\",\"method\":{\"account_number\":\"1473321\",\"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\":\"shipper\",\"method\":{\"account_number\":\"1473321\",\"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\":\"Panda\",\"company_name\":\"Hicom Glenmarie\",\"street1\":\"long long ago\",\"country\":\"AUS\",\"phone\":\"1-403-504-5496\",\"email\":\"test@panda.com\",\"state\":\"New South Wales\",\"city\":\"GLENWOOD\",\"type\":\"business\",\"postal_code\":\"2768\"},\"ship_to\":{\"contact_name\":\"Duncan\",\"company_name\":\"Hicom Glenmarie \",\"street1\":\"australia city\",\"country\":\"AUS\",\"phone\":\"1-403-504-5496\",\"email\":\"test2@duncan.com\",\"type\":\"residential\",\"postal_code\":\"2190\",\"city\":\"Chullora\",\"state\":\"NSW\"}},\"billing\":{\"paid_by\":\"shipper\",\"method\":{\"account_number\":\"1473321\",\"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":"shipper","method":{"account_number":"1473321","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":"Panda","company_name":"Hicom Glenmarie","street1":"long long ago","country":"AUS","phone":"1-403-504-5496","email":"test@panda.com","state":"New South Wales","city":"GLENWOOD","type":"business","postal_code":"2768"},"ship_to":{"contact_name":"Duncan","company_name":"Hicom Glenmarie ","street1":"australia city","country":"AUS","phone":"1-403-504-5496","email":"test2@duncan.com","type":"residential","postal_code":"2190","city":"Chullora","state":"NSW"}},"billing":{"paid_by":"shipper","method":{"account_number":"1473321","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":"shipper","method":{"account_number":"1473321","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":"Panda","company_name":"Hicom Glenmarie","street1":"long long ago","country":"AUS","phone":"1-403-504-5496","email":"test@panda.com","state":"New South Wales","city":"GLENWOOD","type":"business","postal_code":"2768"},"ship_to":{"contact_name":"Duncan","company_name":"Hicom Glenmarie ","street1":"australia city","country":"AUS","phone":"1-403-504-5496","email":"test2@duncan.com","type":"residential","postal_code":"2190","city":"Chullora","state":"NSW"}},"billing":{"paid_by":"shipper","method":{"account_number":"1473321","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": "shipper",
"method": {
"account_number": "1473321",
"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": "Panda",
"company_name": "Hicom Glenmarie",
"street1": "long long ago",
"country": "AUS",
"phone": "1-403-504-5496",
"email": "test@panda.com",
"state": "New South Wales",
"city": "GLENWOOD",
"type": "business",
"postal_code": "2768"
},
"ship_to": {
"contact_name": "Duncan",
"company_name": "Hicom Glenmarie ",
"street1": "australia city",
"country": "AUS",
"phone": "1-403-504-5496",
"email": "test2@duncan.com",
"type": "residential",
"postal_code": "2190",
"city": "Chullora",
"state": "NSW"
}
},
"billing": {
"paid_by": "shipper",
"method": {
"account_number": "1473321",
"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":"shipper","method":{"account_number":"1473321","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":"Panda","company_name":"Hicom Glenmarie","street1":"long long ago","country":"AUS","phone":"1-403-504-5496","email":"test@panda.com","state":"New South Wales","city":"GLENWOOD","type":"business","postal_code":"2768"},"ship_to":{"contact_name":"Duncan","company_name":"Hicom Glenmarie ","street1":"australia city","country":"AUS","phone":"1-403-504-5496","email":"test2@duncan.com","type":"residential","postal_code":"2190","city":"Chullora","state":"NSW"}},"billing":{"paid_by":"shipper","method":{"account_number":"1473321","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_domestic_express ,omniparcel_domestic_standard ,omniparcel_ecommerce_express_tracked ,omniparcel_ecommerce_standard_tracked ,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": []
}
}
}
Retrieve a label
{}
curl --request GET \
--url https://sandbox-api.postmen.com/v3/labels/ \
--header 'content-type: application/json' \
--header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
using System;
using System.Net;
using System.IO;
class ExamplePostmen
{
static void Main(string[] args)
{
WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/labels/");
httpWebRequest.ContentType = "application/json";
httpWebRequest.Method = "GET";
httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
string result = streamReader.ReadToEnd();
Console.WriteLine(result);
}
}
}
import com.squareup.okhttp.*;
public class test {
public static void main(String[] args) {
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
Request request = new Request.Builder()
.url("https://sandbox-api.postmen.com/v3/labels/")
.get()
.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
.addHeader("content-type", "application/json")
.build();
try {
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
} catch (Exception e) {
System.err.println("Caught IOException: " + e.getMessage());
}
}
}
var request = require("request");
var options = {
method: 'GET',
url: 'https://sandbox-api.postmen.com/v3/labels/',
headers: {
'content-type': 'application/json',
'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
<?php
$url = 'https://sandbox-api.postmen.com/v3/labels/';
$method = 'GET';
$headers = array(
"content-type: application/json",
"postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_RETURNTRANSFER => true,
CURLOPT_URL => $url,
CURLOPT_CUSTOMREQUEST => $method,
CURLOPT_HTTPHEADER => $headers,
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>
# Make sure to install requests: pip install requests
import requests
url = 'https://sandbox-api.postmen.com/v3/labels/'
headers = {
'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
'content-type': 'application/json'
}
response = requests.request('GET', url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI('https://sandbox-api.postmen.com/v3/labels/')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
request['content-type'] = 'application/json'
response = http.request(request)
puts response.read_body
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": []
}
}
}
List all labels
Optional parameters
Name | Type | Description |
---|---|---|
shipper_account_id | string | Shipper account ID |
status | string | Label status Accepts: creating ,created ,cancelling ,cancelled ,manifesting ,manifested ,failed . |
limit | string | Number of records per page |
created_at_min | string | Start date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, default: 24hrs ago) |
created_at_max | string | End date and time of the record created (format YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS+00:00, default: NOW()) |
tracking_numbers | string | Tracking numbers (separated by comma) |
s | string | Partial search of tracking_number or reference |
next_token | string | Next token |
{}
curl --request GET \
--url https://sandbox-api.postmen.com/v3/labels \
--header 'content-type: application/json' \
--header 'postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e' \
using System;
using System.Net;
using System.IO;
class ExamplePostmen
{
static void Main(string[] args)
{
WebRequest httpWebRequest = WebRequest.Create("https://sandbox-api.postmen.com/v3/labels");
httpWebRequest.ContentType = "application/json";
httpWebRequest.Method = "GET";
httpWebRequest.Headers["postmen-api-key"] = "8fc7966b-679b-4a57-911d-c5a663229c9e";
HttpWebResponse httpResponse = (HttpWebResponse)httpWebRequest.GetResponse();
using (StreamReader streamReader = new StreamReader(httpResponse.GetResponseStream()))
{
string result = streamReader.ReadToEnd();
Console.WriteLine(result);
}
}
}
import com.squareup.okhttp.*;
public class test {
public static void main(String[] args) {
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("application/json");
Request request = new Request.Builder()
.url("https://sandbox-api.postmen.com/v3/labels")
.get()
.addHeader("postmen-api-key", "8fc7966b-679b-4a57-911d-c5a663229c9e")
.addHeader("content-type", "application/json")
.build();
try {
Response response = client.newCall(request).execute();
System.out.println(response.body().string());
} catch (Exception e) {
System.err.println("Caught IOException: " + e.getMessage());
}
}
}
var request = require("request");
var options = {
method: 'GET',
url: 'https://sandbox-api.postmen.com/v3/labels',
headers: {
'content-type': 'application/json',
'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e'
}
};
request(options, function (error, response, body) {
if (error) throw new Error(error);
console.log(body);
});
<?php
$url = 'https://sandbox-api.postmen.com/v3/labels';
$method = 'GET';
$headers = array(
"content-type: application/json",
"postmen-api-key: 8fc7966b-679b-4a57-911d-c5a663229c9e"
);
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_RETURNTRANSFER => true,
CURLOPT_URL => $url,
CURLOPT_CUSTOMREQUEST => $method,
CURLOPT_HTTPHEADER => $headers,
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>
# Make sure to install requests: pip install requests
import requests
url = 'https://sandbox-api.postmen.com/v3/labels'
headers = {
'postmen-api-key': '8fc7966b-679b-4a57-911d-c5a663229c9e',
'content-type': 'application/json'
}
response = requests.request('GET', url, headers=headers)
print(response.text)
require 'uri'
require 'net/http'
url = URI('https://sandbox-api.postmen.com/v3/labels')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request['postmen-api-key'] = '8fc7966b-679b-4a57-911d-c5a663229c9e'
request['content-type'] = 'application/json'
response = http.request(request)
puts response.read_body
Name | Type | Description |
---|---|---|
next_token | string or null | Any of string or null |
limit | number | Number of records per page |
labels | array of a label object | A label object |
Response example
{
"meta": {
"code": 200,
"message": "OK",
"details": []
},
"data": {
"next_token": "eyJjcmVhdGVkX2F0IjoiMjAxNS0xMS0y0000000000oyMC4wNjRaIiwiaWQiOiJlMGU1NGQ3My1iN2Qz0000000000kzZi1lMjgwNzc1ZDdlMDUiLCJ1c2VyX2lkIjoiN0000000000tNjIyNS00ZTBiLTg5ZTQtZTM3N2M3YWM5ZDk4In0=",
"limit": 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"
}
]
}
}