Sign in

v1

latestOpenAPI 3.0.02026-07-1397337495.2 KB
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 package type, such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.

namestring required
descriptionstring nullable

Provides a helpful description for the custom package.

Example request

{
  "package_id": "se-28529731",
  "package_code": "small_flat_rate_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 package type, such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.

namestring required
descriptionstring nullable

Provides a helpful description for the custom package.

Example response

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