Skip to content

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
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

Get credential requirements

Request

Get the format and fields required for connecting an LTL carrier account. The carrier_code parameter should be the carrier's SCAC.

Security
api_key
Path
carrier_codestringrequired

The SCAC (Standard Carrier Alpha Code) for the LTL carrier

curl -i -X GET \
  'https://docs.shipstation.com/_mock/apis/shipengine/openapi/v-beta/ltl/carriers/{carrier_code}/credential_requirements' \
  -H 'API-Key: YOUR_API_KEY_HERE'

Responses

The request was successful

Bodyapplication/json
credential_requirementsArray of objects

List of required credential fields

Response
application/json
{ "credential_requirements": [ {} ] }

List connected LTL carriers

Request

Retrieve a list of all connected LTL carrier accounts, including available accessorial services, container types, and service levels.

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

Responses

The request was successful

Bodyapplication/json
carriersArray of objects(ltl_carrier_response)

Array of connected LTL carrier accounts

Response
application/json
{ "carriers": [ {} ] }

Connect LTL carrier

Request

Connect a new LTL carrier account by providing the required credentials. Use the credential requirements endpoint to determine what fields are needed.

Security
api_key
Bodyapplication/jsonrequired
carrier_codestringrequired

SCAC code for the carrier

Example: "FXFE"
credentialsobjectrequired

Carrier-specific credentials (use credential_requirements endpoint to get required fields)

credentials.​property name*stringadditional property
nicknamestring

Optional friendly name for this carrier connection

Example: "FedEx Freight Production"
curl -i -X POST \
  https://docs.shipstation.com/_mock/apis/shipengine/openapi/v-beta/ltl/carriers \
  -H 'API-Key: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "carrier_code": "FXFE",
    "credentials": {
      "property1": "string",
      "property2": "string"
    },
    "nickname": "FedEx Freight Production"
  }'

Responses

Carrier successfully connected

Bodyapplication/json
carrier_idstring(uuid)

Unique identifier for the carrier

Example: "aed2a8c0-7998-4fef-9a82-2cab5f527dc2"
namestring

Carrier name

Example: "Test Carrier"
countriesArray of strings

Countries supported by this carrier

Example: ["US","CA","MX"]
featuresArray of strings

Features supported by this carrier

Example: ["quote","spot_quote","scheduled_pickup","tracking"]
optionsArray of objects

Available accessorial services

packagesArray of objects

Available container types

Response
application/json
{ "carrier_id": "aed2a8c0-7998-4fef-9a82-2cab5f527dc2", "name": "Test Carrier", "countries": [ "US", "CA", "MX" ], "features": [ "quote", "spot_quote", "scheduled_pickup", "tracking" ], "options": [ {} ], "packages": [ {} ] }

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