Shipengine

ShipEngine API

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

Logistics & shipping#openapi#transport

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Getting Started

If you're new to REST APIs then be sure to read our introduction to REST to understand the basics. Learn how to authenticate yourself to ShipEngine, and then use our sandbox environment to kick the tires and get familiar with our API. If you run into any problems, then be sure to check the error handling guide for tips.

Here are some step-by-step tutorials to get you started:

Shipping Labels for Every Major Carrier

ShipEngine makes it easy to create shipping labels for any carrier and download them in a variety of file formats. You can even customize labels with your own messages and images.

Real-Time Package Tracking

With ShipEngine you can get the current status of a package or subscribe to real-time tracking updates via webhooks. You can also create custimized tracking pages with your own branding so your customers will always know where their package is.

Compare Shipping Costs Across Carriers

Make sure you ship as cost-effectively as possible by comparing rates across carriers using the ShipEngine Rates API. Or if you don't know the full shipment details yet, then you can get rate estimates with limited address info.

Worldwide Address Validation

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.

Endpoints 84

addresses

  • PUTParse an address/v1/addresses/recognizeThe address-recognition API makes it easy for you to extract address data from unstructured text, including the recipient name, line 1, line 2, city, postal…
  • POSTValidate An Address/v1/addresses/validateAddress validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references…

batches

  • GETList Batches/v1/batches?status=open&page=2&page_size=50&sort_dir=desc&batch_number=string&sort_by=ship_dateList Batches associated with your Shipengine account
  • POSTCreate A Batch/v1/batchesCreate a Batch
  • GETGet Batch By External ID/v1/batches/external_batch_id/:external_batch_idGet Batch By External ID
  • GETGet Batch By ID/v1/batches/:batch_idGet Batch By ID
  • PUTUpdate Batch By Id/v1/batches/:batch_idUpdate Batch By Id
  • DELETEDelete Batch By Id/v1/batches/:batch_idDelete Batch By Id
  • POSTAdd to a Batch/v1/batches/:batch_id/addAdd a Shipment or Rate to a Batch
  • GETGet Batch Errors/v1/batches/:batch_id/errors?page=2&pagesize=1Error handling in batches are handled differently than in a single synchronous request. You must retrieve the status of your batch by getting a batch and…
  • POSTProcess Batch ID Labels/v1/batches/:batch_id/process/labelsProcess Batch ID Labels
  • POSTRemove From Batch/v1/batches/:batch_id/removeRemove a shipment or rate from a batch

carrier_accounts

  • POSTConnect a carrier account/v1/connections/carriers/:carrier_nameConnect a carrier account
  • DELETEDisconnect a carrier/v1/connections/carriers/:carrier_name/:carrier_idDisconnect a carrier
  • GETGet carrier settings/v1/connections/carriers/:carrier_name/:carrier_id/settingsGet carrier settings
  • PUTUpdate carrier settings/v1/connections/carriers/:carrier_name/:carrier_id/settingsUpdate carrier settings

carriers

  • GETList Carriers/v1/carriersList all carriers that have been added to this account
  • GETGet Carrier By ID/v1/carriers/:carrier_idRetrive carrier info by ID
  • PUTAdd Funds To Carrier/v1/carriers/:carrier_id/add_fundsAdd Funds To A Carrier
  • GETGet Carrier Options/v1/carriers/:carrier_id/optionsGet a list of the options available for the carrier
  • GETList Carrier Package Types/v1/carriers/:carrier_id/packagesList the package types associated with the carrier
  • GETList Carrier Services/v1/carriers/:carrier_id/servicesList the services associated with the carrier ID

downloads

  • GETDownload File/v1/downloads/:dir/:subdir/:filename?download=string&rotation=0Get File

insurance

  • POSTConnect a Shipsurance Account/v1/connections/insurance/shipsuranceConnect a Shipsurance Account
  • DELETEDisconnect a Shipsurance Account/v1/connections/insurance/shipsuranceDisconnect a Shipsurance Account
  • PATCHAdd Funds To Insurance/v1/insurance/shipsurance/add_fundsYou may need to auto fund your account from time to time. For example, if you don't normally ship items over $100, and may want to add funds to insurance…
  • GETGet Insurance Funds Balance/v1/insurance/shipsurance/balanceRetrieve the balance of your Shipsurance account.

labels

  • GETList labels/v1/labels?label_status=processing&service_code=usps_first_class_mail&carrier_id=se-28529731&tracking_number=9405511899223197428490&batch_id=se-28529731&rate_id=se-28529731&shipment_id=se-28529731&warehouse_id=se-28529731&created_at_start=2019-03-12T19:24:13.657Z&created_at_end=2019-03-12T19:24:13.657Z&page=2&page_size=50&sort_dir=desc&sort_by=created_atThis endpoint returns a list of labels that you've created. You can optionally filter the results as well as control their sort order and the number of…
  • POSTPurchase Label/v1/labelsPurchase and print a label for shipment
  • GETGet Label By External Shipment ID/v1/labels/external_shipment_id/:external_shipment_id?label_download_type=urlFind a label by using the external shipment id that was used during label creation
  • POSTPurchase Label with Rate ID/v1/labels/rates/:rate_idWhen retrieving rates for shipments using the /rates endpoint, the returned information contains a rate_id property that can be used to generate a label…
  • POSTPurchase Label with Shipment ID/v1/labels/shipment/:shipment_idPurchase a label using a shipment ID that has already been created with the desired address and package info.
  • GETGet Label By ID/v1/labels/:label_id?label_download_type=urlRetrieve information for individual labels.
  • POSTCreate a return label/v1/labels/:label_id/returnCreate a return label
  • GETGet Label Tracking Information/v1/labels/:label_id/trackRetrieve the label's tracking information
  • PUTVoid a Label By ID/v1/labels/:label_id/voidVoid a label by ID to get a refund.

manifests

  • GETList Manifests/v1/manifests?warehouse_id=se-28529731&ship_date_start=2018-09-23T15:00:00.000Z&ship_date_end=2018-09-23T15:00:00.000Z&created_at_start=2019-03-12T19:24:13.657Z&created_at_end=2019-03-12T19:24:13.657Z&carrier_id=se-28529731&page=2&page_size=50&label_ids=se-28529731Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time.
  • POSTCreate Manifest/v1/manifestsEach ShipEngine manifest is created for a specific warehouse, so you'll need to provide the warehouse_id rather than the ship_from address. You can create a…
  • GETGet Manifest Request By Id/v1/manifests/requests/:manifest_request_idGet Manifest Request By Id
  • GETGet Manifest By Id/v1/manifests/:manifest_idGet Manifest By Id

package_pickups

  • GETList Scheduled Pickups/v1/pickups?carrier_id=se-28529731&warehouse_id=se-28529731&created_at_start=2019-03-12T19:24:13.657Z&created_at_end=2019-03-12T19:24:13.657Z&page=2&page_size=50List all pickups that have been scheduled for this carrier
  • POSTSchedule a Pickup/v1/pickupsSchedule a package pickup with a carrier
  • GETGet Pickup By ID/v1/pickups/:pickup_idGet Pickup By ID
  • DELETEDelete a Scheduled Pickup/v1/pickups/:pickup_idDelete a previously-scheduled pickup by ID

package_types

  • GETList Custom Package Types/v1/packagesList the custom package types associated with the account
  • POSTCreate Custom Package Type/v1/packagesCreate a custom package type to better assist in getting accurate rate estimates
  • GETGet Custom Package Type By ID/v1/packages/:package_idGet Custom Package Type by ID
  • PUTUpdate Custom Package Type By ID/v1/packages/:package_idUpdate the custom package type object by ID
  • DELETEDelete A Custom Package By ID/v1/packages/:package_idDelete a custom package using the ID

rates

  • POSTGet Shipping Rates/v1/ratesIt's not uncommon that you want to give your customer the choice between whether they want to ship the fastest, cheapest, or the most trusted route. Most…
  • POSTGet Bulk Rates/v1/rates/bulkGet Bulk Shipment Rates
  • POSTEstimate Rates/v1/rates/estimateGet Rate Estimates
  • GETGet Rate By ID/v1/rates/:rate_idRetrieve a previously queried rate by its ID

service_points

  • POSTList Service Points/v1/service_points/listList carrier service points by location
  • GETGet Service Point By ID/v1/service_points/:carrier_code/:country_code/:service_point_idReturns a carrier service point by using the service_point_id

shipments

  • GETList Shipments/v1/shipments?shipment_status=pending&batch_id=se-28529731&tag=Letters_to_santa&created_at_start=2019-03-12T19:24:13.657Z&created_at_end=2019-03-12T19:24:13.657Z&modified_at_start=2019-03-12T19:24:13.657Z&modified_at_end=2019-03-12T19:24:13.657Z&page=2&page_size=50&sales_order_id=string&sort_dir=desc&sort_by=modified_atGet list of Shipments
  • POSTCreate Shipments/v1/shipmentsCreate one or multiple shipments.
  • GETGet Shipment By External ID/v1/shipments/external_shipment_id/:external_shipment_idQuery Shipments created using your own custom ID convention using this endpint
  • PUTParse shipping info/v1/shipments/recognizeThe shipment-recognition API makes it easy for you to extract shipping data from unstructured text, including people's names, addresses, package weights and…
  • GETGet Shipment By ID/v1/shipments/:shipment_idGet an individual shipment based on its ID
  • PUTUpdate Shipment By ID/v1/shipments/:shipment_idUpdate a shipment object based on its ID
  • PUTCancel a Shipment/v1/shipments/:shipment_id/cancelMark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An…
  • GETGet Shipment Rates/v1/shipments/:shipment_id/rates?created_at_start=2019-03-12T19:24:13.657ZGet Rates for the shipment information associated with the shipment ID
  • POSTAdd Tag to Shipment/v1/shipments/:shipment_id/tags/:tag_nameAdd a tag to the shipment object
  • DELETERemove Tag from Shipment/v1/shipments/:shipment_id/tags/:tag_nameRemove an existing tag from the Shipment object

tags

  • GETGet Tags/v1/tagsGet a list of all tags associated with an account.
  • POSTCreate a New Tag/v1/tags/:tag_nameCreate a new Tag for customizing how you track your shipments
  • DELETEDelete Tag/v1/tags/:tag_nameDelete a tag that is no longer needed
  • PUTUpdate Tag Name/v1/tags/:tag_name/:new_tag_nameChange a tag name while still keeping the relevant shipments attached to it

tokens

  • POSTGet Ephemeral Token/v1/tokens/ephemeral?redirect=shipengine-dashboardThis endpoint returns a token that can be passed to an application for authorized access. The lifetime of this token is 10 seconds.

tracking

  • GETGet Tracking Information/v1/tracking?carrier_code=stamps_com&tracking_number=9405511899223197428490Retrieve package tracking information
  • POSTStart Tracking a Package/v1/tracking/start?carrier_code=stamps_com&tracking_number=9405511899223197428490Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via…
  • POSTStop Tracking a Package/v1/tracking/stop?carrier_code=stamps_com&tracking_number=9405511899223197428490Unsubscribe from tracking updates for a package.

warehouses

  • GETList Warehouses/v1/warehousesRetrieve a list of warehouses associated with this account.
  • POSTCreate Warehouse/v1/warehousesCreate a warehouse location that you can use to create shipping items by simply passing in the generated warehouse id. If the return address is not supplied…
  • GETGet Warehouse By Id/v1/warehouses/:warehouse_idRetrieve warehouse data based on the warehouse ID
  • PUTUpdate Warehouse By Id/v1/warehouses/:warehouse_idUpdate Warehouse object information
  • DELETEDelete Warehouse By ID/v1/warehouses/:warehouse_idDelete a warehouse by ID
  • PUTUpdate Warehouse Settings/v1/warehouses/:warehouse_id/settingsUpdate Warehouse settings object information

webhooks

  • GETList Webhooks/v1/environment/webhooksList all webhooks currently enabled for the account.
  • POSTCreate a Webhook/v1/environment/webhooksCreate a webook for specific events in the environment.
  • GETGet Webhook By ID/v1/environment/webhooks/:webhook_idRetrieve individual webhook by an ID
  • PUTUpdate a Webhook/v1/environment/webhooks/:webhook_idUpdate the webhook url property
  • DELETEDelete Webhook By ID/v1/environment/webhooks/:webhook_idDelete a webhook

API details

Base URL
https://api.shipengine.com
Authentication
An API key in the API-Key header
Operations
84 operations on 62 pathsGET 35POST 26PUT 13DELETE 9PATCH 1
Main resources
batches 10shipments 10labels 9carriers 6warehouses 6package_types 5webhooks 5carrier_accounts 4insurance 4manifests 4
Response formats
application/json text/plain application/pdf application/zpl
Description format
OpenAPI 3.0.0, API version 1.1.202303022103
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the ShipEngine API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the ShipEngine API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Parse an address” (PUT /v1/addresses/recognize), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the ShipEngine API?

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.… It is listed under Logistics & shipping and has 84 endpoints.

Who publishes the ShipEngine API?

It is listed from Shipengine's public API description (an OpenAPI document), not published by Shipengine on Swastik Codes. Anyone who controls shipengine.com can claim the profile by adding a DNS TXT record.

What is the base URL of the ShipEngine API?

Requests go to https://api.shipengine.com. Endpoint paths are added to this base URL.

How do I authenticate with the ShipEngine API?

With an API key in the API-Key header.

How many endpoints does the ShipEngine API have?

84 operations on 62 paths (35 GET, 26 POST, 13 PUT, 9 DELETE, 1 PATCH). The largest groups are batches, shipments, labels, carriers.

Is forking the ShipEngine API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.