curl --request GET \
--url https://{defaultHost}/v1/parcel_templates/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{defaultHost}/v1/parcel_templates/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{defaultHost}/v1/parcel_templates/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{defaultHost}/v1/parcel_templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/parcel_templates/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{defaultHost}/v1/parcel_templates/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/parcel_templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "2518ee63-2448-49df-9bea-fd6aa3e150d5",
"object": "parcel_template",
"default": false,
"dimensions": {
"length": 10,
"width": 8,
"height": 6,
"unit": "in"
},
"name": "Standard Box",
"package_type": "box",
"weight": 5,
"weight_unit": "lb",
"carrier_parcel_template_token": null,
"carrier_token": null,
"carrier_name": null,
"carrier_logo_url": null,
"shipping_provider": null,
"created_at": 1787228419,
"updated_at": 1787228419
}Retrieve
Retrieves details of a specific parcel template.
curl --request GET \
--url https://{defaultHost}/v1/parcel_templates/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://{defaultHost}/v1/parcel_templates/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{defaultHost}/v1/parcel_templates/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{defaultHost}/v1/parcel_templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{defaultHost}/v1/parcel_templates/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{defaultHost}/v1/parcel_templates/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/parcel_templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "2518ee63-2448-49df-9bea-fd6aa3e150d5",
"object": "parcel_template",
"default": false,
"dimensions": {
"length": 10,
"width": 8,
"height": 6,
"unit": "in"
},
"name": "Standard Box",
"package_type": "box",
"weight": 5,
"weight_unit": "lb",
"carrier_parcel_template_token": null,
"carrier_token": null,
"carrier_name": null,
"carrier_logo_url": null,
"shipping_provider": null,
"created_at": 1787228419,
"updated_at": 1787228419
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
Success
The UUID of the specific object.
A string describing the object type returned.
Whether or not this parcel template is the account's default.
A name for this parcel template.
The type of package – one of box, poly_mailer.
The physical dimensions of this parcel template. Populated from the carrier's own preset when carrier_parcel_template_token resolves to a fixed-size package, and required otherwise.
Show child attributes
Show child attributes
The weight of this parcel template.
The weight unit for this parcel template – one of lb, oz, kg, g.
The token of a carrier parcel template (e.g. USPS_SmallFlatRateBox). When set, dimensions are populated from the carrier's own preset unless it allows custom dimensions, and shipments using this parcel template are quoted for that carrier only. Set to null to turn this back into a plain parcel template.
Expandable – The associated shipping provider ID.
The token of the carrier that provides this template's carrier parcel template, if any (e.g. fedex).
The display name of the carrier that provides this template's carrier parcel template, if any (e.g. FedEx).
URL of the carrier's logo. Null if this template is not carrier provided, or if no logo is available for that carrier.
Time at which the object was created. Measured in seconds since the Unix epoch.
Time at which the object was last updated. Measured in seconds since the Unix epoch.
Was this page helpful?