List
curl --request GET \
--url https://{defaultHost}/v1/shipping_providers/{shipping_provider_id}/carrier_parcel_templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://{defaultHost}/v1/shipping_providers/{shipping_provider_id}/carrier_parcel_templates"
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/shipping_providers/{shipping_provider_id}/carrier_parcel_templates', 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/shipping_providers/{shipping_provider_id}/carrier_parcel_templates",
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/shipping_providers/{shipping_provider_id}/carrier_parcel_templates"
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/shipping_providers/{shipping_provider_id}/carrier_parcel_templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/shipping_providers/{shipping_provider_id}/carrier_parcel_templates")
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{
"object": "list",
"data": [
{
"object": "carrier_parcel_template",
"carrier_token": "fedex",
"carrier_name": "FedEx",
"name": "FedEx® Small Box (S1)",
"token": "FedEx_Box_Small_1",
"length": "12.375",
"width": "10.875",
"height": "1.5",
"distance_unit": "in",
"is_variable_dimensions": false
}
]
}Carrier Parcel Templates
List
Returns the carrier parcel templates available to a shipping provider.
GET
/
v1
/
shipping_providers
/
{shipping_provider_id}
/
carrier_parcel_templates
List
curl --request GET \
--url https://{defaultHost}/v1/shipping_providers/{shipping_provider_id}/carrier_parcel_templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://{defaultHost}/v1/shipping_providers/{shipping_provider_id}/carrier_parcel_templates"
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/shipping_providers/{shipping_provider_id}/carrier_parcel_templates', 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/shipping_providers/{shipping_provider_id}/carrier_parcel_templates",
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/shipping_providers/{shipping_provider_id}/carrier_parcel_templates"
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/shipping_providers/{shipping_provider_id}/carrier_parcel_templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{defaultHost}/v1/shipping_providers/{shipping_provider_id}/carrier_parcel_templates")
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{
"object": "list",
"data": [
{
"object": "carrier_parcel_template",
"carrier_token": "fedex",
"carrier_name": "FedEx",
"name": "FedEx® Small Box (S1)",
"token": "FedEx_Box_Small_1",
"length": "12.375",
"width": "10.875",
"height": "1.5",
"distance_unit": "in",
"is_variable_dimensions": false
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The id of the shipping provider.
Query Parameters
Only return carrier parcel templates for the given carrier. Accepts either the carrier token (e.g. fedex, usps) or its display name (e.g. FedEx, USPS).
Was this page helpful?
⌘I