Site Logo

Custom Package Types

Using packages is a great way to streamline the shipping process.

Define a Package Type

Example Request

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
POST /v1/packages HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__
Content-Type: application/json
{
"package_code": "custom_laptop_box",
"name": "laptop_box",
"dimensions": {
"unit": "inch",
"length": 15,
"width": 20,
"height": 5
},
"description": "Packaging for laptops."
}

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
{
"package_id": "se-100896",
"package_code": "custom_laptop_box",
"name": "laptop_box",
"dimensions": {
"unit": "inch",
"length": 15.0,
"width": 20.0,
"height": 5.0
},
"description": "Packaging for laptops."
}

List Your Package Types

GET /v1/packages

Example Request

1
2
3
GET /v1/packages HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example Response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
"packages": [
{
"package_id": "se-102873",
"package_code": "custom_laptop_box",
"name": "Custom Laptop Box",
"dimensions": {
"unit": "inch",
"length": 15.00,
"width": 20.00,
"height": 5.00
},
"description": ""
}
]
}

Delete a Package Type

DELETE /v1/packages/:package_id

Deleting a package will not disassociate it from any shipments. It will merely stop being available for use with future shipments, and it will stop showing up when listing packages.

Example Request

1
2
3
DELETE /v1/packages HTTP/1.1
Host: api.shipengine.com
API-Key: __YOUR_API_KEY_HERE__

Example Response

If successful, responds with HTTP Status 204, No Content.