cURL

curl https://api.goshippo.com/parcel-templates  \
-H "Authorization: ShippoToken <API_TOKEN>" \
-H "Content-Type: application/json"

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

Carrier Parcel Templates

List all carrier parcel templates

List all carrier parcel template objects. <br> Use the following query string params to filter the results as needed. <br> <ul> <li>`include=all` (the default). Includes templates from all carriers </li> <li>`include=user`. Includes templates only from carriers which the user has added (whether or not they're currently enabled) </li> <li>`include=enabled`. includes templates only for carriers which the user has added and enabled </li> <li>`carrier=*token*`. filter by specific carrier, e.g. fedex, usps </li> </ul>

GET

parcel-templates

cURL

curl https://api.goshippo.com/parcel-templates  \
-H "Authorization: ShippoToken <API_TOKEN>" \
-H "Content-Type: application/json"

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

Authorizations

Authorization

string

header

default:ShippoToken

required

API key authentication using the ShippoToken scheme. Format: Authorization: ShippoToken <API_TOKEN> Example: Authorization: ShippoToken shippo_live_abc123

Headers

SHIPPO-API-VERSION

string

default:2018-02-08

Optional string used to pick a non-default API version to use. See our API version guide.

Example:

"2018-02-08"

Query Parameters

include

enum<string>

filter by user or enabled

Available options:

all,

user,

enabled

carrier

string

filter by specific carrier

Response

List of carrier parcel templates

results

Carrier Parcel Template · object[]

Show child attributes

Retrieve an order

Retrieve a carrier parcel templates

Documentation Index

Authorizations

Headers

Query Parameters

Response