Sign in
latestOpenAPI 3.0.0Proprietary2026-08-22131410675.6 KB

8d8a7cf79204

package_types

Create custom package type

Create a custom package type to better assist in getting accurate rate estimates

post/v1/packages

Request body

package_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

package_codestring required

A unique, user-defined identifier for the custom package type. Must start with "custom_".

namestring required
descriptionstring nullable

Provides a helpful description for the custom package.

Example request

{
  "package_id": "se-28529731",
  "package_code": "custom_laptop_box",
  "name": "laptop_box",
  "description": "Packaging for laptops"
}

Response

The request was a success.

package_idstring

A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.

package_codestring required

A unique identifier for the custom package type. API-created packages start with "custom_". UI-created packages may use other codes.

namestring required
descriptionstring nullable

Provides a helpful description for the custom package.

Example response

{
  "package_id": "se-28529731",
  "package_code": "package",
  "name": "laptop_box",
  "description": "Packaging for laptops"
}