Skip to main content
GET
Retrieve

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

default
boolean

Whether or not this parcel template is the account's default.

name
string

A name for this parcel template.

package_type
string

The type of package – one of box, poly_mailer.

dimensions
object | null

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.

weight
number | null

The weight of this parcel template.

weight_unit
string

The weight unit for this parcel template – one of lb, oz, kg, g.

carrier_parcel_template_token
string | null

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.

shipping_provider
string | null

Expandable – The associated shipping provider ID.

carrier_token
string | null

The token of the carrier that provides this template's carrier parcel template, if any (e.g. fedex).

carrier_name
string | null

The display name of the carrier that provides this template's carrier parcel template, if any (e.g. FedEx).

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.