GOgoshippo
Carrier Parcel Templates

List all carrier parcel templates

Changed on

List all carrier parcel template objects.

Use the following query string params to filter the results as needed:

  • include=all (the default): includes templates from all carriers
  • include=user: includes templates only from carriers which the user has added (whether or not they're currently enabled)
  • include=enabled: includes templates only for carriers which the user has added and enabled
  • carrier=<token>: filter by specific carrier, e.g. fedex, usps
get/parcel-templates

Request

  • Base URL
    https://api.goshippo.com
  • URL
    https://api.goshippo.com/parcel-templates
  • Auth
    API key in header Authorization

Query parameters

include'all' | 'user' | 'enabled'

filter by user or enabled

carrierstring

filter by specific carrier

Headers

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

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

SHIPPO-ACCOUNT-IDstring

Optional. The object ID of a Managed Shippo Account. Platform accounts set this to make the request on behalf of one of their managed accounts. See the Platform accounts guide.

Response

List of carrier parcel templates

Example response

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

Changes