Skip to content
/Package Types

ShipEngine API (1.1.202604070904)

ShipEngine's easy-to-use REST API lets you manage all of your shipping needs without worrying about the complexities of different carrier APIs and protocols. We handle all the heavy lifting so you can focus on providing a first-class shipping experience for your customers at the best possible prices.

Each of ShipEngine's features can be used by itself or in conjunction with each other to build powerful shipping functionality into your application or service.

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL
https://www.shipengine.com/contact/
ShipEngine Sales & Support
sales@shipengine.com
License
Proprietary
Terms of Service
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/apis/shipengine/openapi/
https://api.shipengine.com/

Account

For additional information about the ShipEngine account.

Operations

Addresses

No matter your shipping volume, failed deliveries and address change surcharges cut into your bottom line and damage perception with customers. Our address validation services ensure your packages make it to the right place the first time. Learn how to leverage our address validation services here.

ShipEngine supports address validation for virtually every country on Earth, including the United States, Canada, Great Britain, Australia, Germany, France, Norway, Spain, Sweden, Israel, Italy, and over 160 others.

Operations

Batches

batches

Operations

Carrier Accounts

A carrier account is a connection to a shipping carrier that allows you to create labels, track packages, and more. You can connect your own carrier accounts to ShipEngine, or use one of our built-in carrier accounts. Learn more about carrier accounts here.

Operations

Carriers

carriers

Operations

Downloads

downloads

Operations

Insurance

insurance

Operations

Labels

Print shipping labels for any of the top global carriers in minutes—instead of weeks. Simply connect your existing carrier accounts in the API dashboard, and then begin creating labels.

Operations

LTL Shipping

Less-than-truckload (LTL) shipping API endpoints for managing freight shipments. Connect LTL carriers, request quotes, schedule pickups, and track freight shipments.

Operations

Manifests

manifests

Operations

Package Pickups

Scheduled package pickups

Operations

Package Types

custom package types

Operations

List custom package types

Request

List the custom package types associated with the account

Security
api_key
curl -i -X GET \
  https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/packages \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

The request was a success.

Bodyapplication/json
packagesArray of objects(package_type)read-only

An array of custom package types

Response
application/json
{
  "packages": [
    { … }
  ]
}

Create custom package type

Request

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

Security
api_key
Bodyapplication/jsonrequired
package_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$

A string that uniquely identifies the package.

Example: "se-28529731"
package_codestring(package_code)[ 1 .. 50 ] characters^[a-z0-9]+(_[a-z0-9]+)*$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.

Example: "small_flat_rate_box"
namestring[ 1 .. 50 ] charactersrequired
Example: "laptop_box"
dimensionsobject(dimensions)

The custom dimensions for the package.

descriptionstring or null<= 500 characters

Provides a helpful description for the custom package.

Example: "Packaging for laptops"
curl -i -X POST \
  https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/packages \
  -H 'API-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "package_id": "se-28529731",
    "package_code": "small_flat_rate_box",
    "name": "laptop_box",
    "dimensions": {
      "unit": "inch",
      "length": 0,
      "width": 0,
      "height": 0
    },
    "description": "Packaging for laptops"
  }'

Responses

The request was a success.

Bodyapplication/json
package_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$

A string that uniquely identifies the package.

Example: "se-28529731"
package_codestring(package_code)[ 1 .. 50 ] characters^[a-z0-9]+(_[a-z0-9]+)*$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.

Example: "small_flat_rate_box"
namestring[ 1 .. 50 ] charactersrequired
Example: "laptop_box"
dimensionsobject(dimensions)

The custom dimensions for the package.

descriptionstring or null<= 500 characters

Provides a helpful description for the custom package.

Example: "Packaging for laptops"
Response
application/json
{
  "package_id": "se-28529731",
  "package_code": "small_flat_rate_box",
  "name": "laptop_box",
  "dimensions": {
    "unit": "inch",
    "length": 0,
    "width": 0,
    "height": 0
  },
  "description": "Packaging for laptops"
}

Get custom package type by ID

Request

Get Custom Package Type by ID

Security
api_key
Path
package_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$required

Package ID

Example: se-28529731
curl -i -X GET \
  https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/packages/se-28529731 \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

The request was a success.

Bodyapplication/json
package_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$

A string that uniquely identifies the package.

Example: "se-28529731"
package_codestring(package_code)[ 1 .. 50 ] characters^[a-z0-9]+(_[a-z0-9]+)*$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.

Example: "small_flat_rate_box"
namestring[ 1 .. 50 ] charactersrequired
Example: "laptop_box"
dimensionsobject(dimensions)

The custom dimensions for the package.

descriptionstring or null<= 500 characters

Provides a helpful description for the custom package.

Example: "Packaging for laptops"
Response
application/json
{
  "package_id": "se-28529731",
  "package_code": "small_flat_rate_box",
  "name": "laptop_box",
  "dimensions": {
    "unit": "inch",
    "length": 0,
    "width": 0,
    "height": 0
  },
  "description": "Packaging for laptops"
}

Update custom package type by ID

Request

Update the custom package type object by ID

Security
api_key
Path
package_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$required

Package ID

Example: se-28529731
Bodyapplication/jsonrequired
package_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$

A string that uniquely identifies the package.

Example: "se-28529731"
package_codestring(package_code)[ 1 .. 50 ] characters^[a-z0-9]+(_[a-z0-9]+)*$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.

Example: "small_flat_rate_box"
namestring[ 1 .. 50 ] charactersrequired
Example: "laptop_box"
dimensionsobject(dimensions)

The custom dimensions for the package.

descriptionstring or null<= 500 characters

Provides a helpful description for the custom package.

Example: "Packaging for laptops"
curl -i -X PUT \
  https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/packages/se-28529731 \
  -H 'API-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "package_id": "se-28529731",
    "package_code": "small_flat_rate_box",
    "name": "laptop_box",
    "dimensions": {
      "unit": "inch",
      "length": 0,
      "width": 0,
      "height": 0
    },
    "description": "Packaging for laptops"
  }'

Responses

The request was successful.

Body
string(empty_response_body)= 0 characters
Response
No response example

Delete a custom package by ID

Request

Delete a custom package using the ID

Security
api_key
Path
package_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$required

Package ID

Example: se-28529731
curl -i -X DELETE \
  https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/packages/se-28529731 \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

The request was successful.

Body
string(empty_response_body)= 0 characters
Response
No response example

Rates

Make sure you ship as cost-effectively as possible by quickly comparing rates using the ShipEngine Rates API. As long as you have the carrier connected to your account, you'll be able to see and compare different rates and services.

Operations

Service Points

Service points allow customers to pick up their packages at convenient locations.

Operations

Shipments

Shipments are at the center of the ShipEngine API. A shipment is the first step in creating a shipping label, or creating a manifest. It's also essential for getting shipping rates.

Operations

Tags

tags

Operations

Tokens

Manage authentication tokens for secure API access.

Operations

Tracking

Track packages across any of our 20+ supported carrier accounts and create tracking events to keep your customers up-to-date. Easily integrate real-time tracking information for shipments into your app, email, or SMS.

Operations

Warehouses

warehouses

Operations

Webhooks

Webhooks are a powerful feature of ShipEngine that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipEngine will automatically contact your servers when the state changes. This can include parcel tracking events, notification of the completion of a batch operation, or new sales orders.

Operations
Shipstation
  • Facebook
  • Linkedin
  • Instagram
Auctane
ShipStation is powered by Auctane, a global delivery experience company. © 2026 Auctane, Inc. All rights reserved