Skip to main content
POST
/
v1
/
parcel_templates
Create
curl --request POST \
  --url https://{defaultHost}/v1/parcel_templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "parcel_template": {
    "name": "Small Box",
    "dimensions": {
      "length": 10,
      "width": 8,
      "height": 6,
      "unit": "in"
    }
  }
}
'
{
  "id": "aacc1108-ad37-476f-8c50-360e4e909f94",
  "object": "parcel_template",
  "default": false,
  "dimensions": {
    "length": 10,
    "width": 8,
    "height": 6,
    "unit": "in"
  },
  "name": "Small Box",
  "package_type": "box",
  "weight": null,
  "weight_unit": "lb",
  "created_at": 1772112987,
  "updated_at": 1772112987
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
parcel_template
object

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

The physical dimensions of this parcel template.

​
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.

​
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.