Skip to content
Full API Reference/
/
Get carrier settings

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

Connect a carrier account

Request

Connect a carrier account

Security
api_key
Path
carrier_namestring(carrier_name)required

The carrier name, such as stamps_com, ups, fedex, or dhl_express.

Enum"access_worldwide""amazon_buy_shipping""amazon_shipping_uk""apc""asendia""australia_post""canada_post""dhl_ecommerce""dhl_express""dhl_express_au"
Example: dhl_express
Bodyapplication/jsonrequired
One of:

An Access Worldwide account information request body

nicknamestringnon-emptyrequired

The nickname associated with the carrier connection

Example: "Stamps.com"
usernamestringnon-emptyrequired

Access Worldwide Username

passwordstringnon-emptyrequired

Access Worldwide Password

curl -i -X POST \
  https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/connections/carriers/dhl_express \
  -H 'API-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "nickname": "Stamps.com",
    "username": "string",
    "password": "string"
  }'

Responses

The request was a success.

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

A string that uniquely identifies the carrier

Example: "se-28529731"
Response
application/json
{
  "carrier_id": "se-28529731"
}

Disconnect a carrier

Request

Disconnect a carrier

Security
api_key
Path
carrier_namestring(carrier_name)required

The carrier name, such as stamps_com, ups, fedex, or dhl_express.

Enum"access_worldwide""amazon_buy_shipping""amazon_shipping_uk""apc""asendia""australia_post""canada_post""dhl_ecommerce""dhl_express""dhl_express_au"
Example: dhl_express
carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$required

Carrier ID

Example: se-28529731
curl -i -X DELETE \
  https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/connections/carriers/dhl_express/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

Get carrier settings

Request

Get carrier settings

Security
api_key
Path
carrier_namestring(carrier_name_with_settings)required

The carrier name, such as ups, fedex, or dhl_express.

Enum"dhl_express""fedex""newgistics""ups"
Example: dhl_express
carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$required

Carrier ID

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

Responses

The request was a success.

Bodyapplication/json
One of:

A DHL Express response body

nicknamestringnon-empty

Account nickname

should_hide_account_number_on_archive_docboolean

Indicates if the account number should be hidden on the archive documentation

is_primary_accountboolean

Indicates if this is primary account

Response
application/json
{
  "nickname": "string",
  "should_hide_account_number_on_archive_doc": true,
  "is_primary_account": true
}

Update carrier settings

Request

Update carrier settings

Security
api_key
Path
carrier_namestring(carrier_name_with_settings)required

The carrier name, such as ups, fedex, or dhl_express.

Enum"dhl_express""fedex""newgistics""ups"
Example: dhl_express
carrier_idstring(se_id)[ 1 .. 25 ] characters^se(-[a-z0-9]+)+$required

Carrier ID

Example: se-28529731
Bodyapplication/jsonrequired
One of:

An update dhl express settings request body

nicknamestringnon-empty

Account nickname

should_hide_account_number_on_archive_docboolean

Indicates if the account number should be hidden on the archive documentation

is_primary_accountboolean

Indicates if this is primary account

curl -i -X PUT \
  https://docs.shipstation.com/_mock/apis/shipengine/openapi/v1/connections/carriers/dhl_express/se-28529731/settings \
  -H 'API-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "nickname": "string",
    "should_hide_account_number_on_archive_doc": true,
    "is_primary_account": true
  }'

Responses

The request was successful.

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

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

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