Sign in

v1

latestOpenAPI 3.1.02026-07-1270243932.3 KB
Carrier Parcel Templates

Retrieve a carrier parcel templates

Fetches the parcel template information for a specific carrier parcel template, identified by the token.

get/parcel-templates/{CarrierParcelTemplateToken}

Path parameters

CarrierParcelTemplateTokenstring required

The unique string representation of the carrier parcel template

Headers

SHIPPO-API-VERSIONstring
Example:2018-02-08

Optional string used to pick a non-default API version to use. See our <a href="https://docs.goshippo.com/docs/api_concepts/apiversioning/">API version</a> guide.

Response

Carrier parcel template

carrierstring

The name of the carrier that provides this parcel template

distance_unit'cm' | 'in' | 'ft' | 'm' | 'mm' | 'yd'

The measure unit used for length, width and height.

heightstring

The height of the package, in units specified by the distance_unit attribute

is_variable_dimensionsboolean

True if the carrier parcel template allows custom dimensions, such as USPS Softpack.

lengthstring

The length of the package, in units specified by the distance_unit attribute

namestring

The name of the carrier parcel template

tokenstring

The unique string representation of the carrier parcel template

widthstring

The width of the package, in units specified by the distance_unit attribute

Example response

{
  "carrier": "FedEx",
  "distance_unit": "in",
  "height": "1.5",
  "length": "12.375",
  "name": "FedEx® Small Box (S1)",
  "token": "FedEx_Box_Small_1",
  "width": "10.875"
}