---
title: "Retrieves a user parcel template"
method: GET
path: "/user-parcel-templates/{UserParcelTemplateObjectId}"
tags: ["User Parcel Templates"]
---

# Retrieves a user parcel template

`GET /user-parcel-templates/{UserParcelTemplateObjectId}`

Returns the parcel template information for a specific user parcel
template, identified by the object ID.

## Path parameters

- `UserParcelTemplateObjectId` string, required

## Headers

- `SHIPPO-API-VERSION` string

## Response `200`

User parcel template

- UserParcelTemplate
  - `distance_unit` 'cm' | 'in' | 'ft' | 'm' | 'mm' | 'yd' — The measure unit used for length, width and height.
  - `height` string — The height of the package, in units specified by the `distance_unit` attribute. Required, but if using a preset carrier template then this field must be empty.
  - `length` string — The length of the package, in units specified by the `distance_unit` attribute. Required, but if using a preset carrier template then this field must be empty.
  - `name` string — The name of the User Parcel Template
  - `weight` string — The weight of the package, in units specified by the weight_unit attribute.
  - `weight_unit` 'g' | 'kg' | 'lb' | 'oz' — The unit used for weight.
  - `width` string — The width of the package, in units specified by the `distance_unit` attribute. Required, but if using a preset carrier template then this field must be empty.
  - `object_created` string, date-time — Date and time of User Parcel Template creation
  - `object_id` string — Unique identifier of the given User Parcel Template object
  - `object_owner` string — Username of the user who created the User Parcel Template object
  - `object_updated` string, date-time — Date and time of last update on User Parcel Template
  - `template` CarrierParcelTemplate
    - `carrier` string — 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.
    - `height` string — The height of the package, in units specified by the distance_unit attribute
    - `is_variable_dimensions` boolean — True if the carrier parcel template allows custom dimensions, such as USPS Softpack.
    - `length` string — The length of the package, in units specified by the distance_unit attribute
    - `name` string — The name of the carrier parcel template
    - `token` string — The unique string representation of the carrier parcel template
    - `width` string — The width of the package, in units specified by the distance_unit attribute

## Other responses

- `400` — Bad request

---

[API](https://skmtc.net/goshippo/apis/shippo-external-api.md) · [All operations](https://skmtc.net/goshippo/apis/shippo-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/goshippo/shippo-external-api/revisions/13280a44853c/schema)