← Back to catalog

Other

ShipEngine

auto-generated
swirls add shipengine …
actionPATCHv1.0.0

Add Funds To Insurance

You 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 rather than keeping the account funded.

Source
actionPUTv1.0.0

Cancel a Shipment

Mark 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 example use case would be if a batch label creation job is going to run at a set time and only queries `pending` shipments. Marking a shipment as cancelled would remove it from this process

Source
actionPOSTv1.0.0

Create a New Tag

Create a new Tag for customizing how you track your shipments

Source
actionPOSTv1.0.0

Create Custom Package Type

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

Source
actionPOSTv1.0.0

Create Manifest

Each 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 warehouse for each location that you want to create manifests for.

Source
actionPOSTv1.0.0

Create Warehouse

Create 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 in the request body then it is assumed that the origin address is the return address as well

Source
actionDELETEv1.0.0

Delete Tag

Delete a tag that is no longer needed

Source
actionGETv1.0.0

Get Carrier Options

Get a list of the options available for the carrier

Source
actionGETv1.0.0

Get Label By ID

Retrieve information for individual labels.

Source
actionGETv1.0.0

Get Rate By ID

Retrieve a previously queried rate by its ID

Source
actionGETv1.0.0

Get Service Point By ID

Returns a carrier service point by using the service_point_id

Source
actionGETv1.0.0

Get Shipment By External ID

Query Shipments created using your own custom ID convention using this endpint

Source
actionGETv1.0.0

Get Shipment By ID

Get an individual shipment based on its ID

Source
actionGETv1.0.0

Get Shipment Rates

Get Rates for the shipment information associated with the shipment ID

Source
actionGETv1.0.0

Get Tags

Get a list of all tags associated with an account.

Source
actionGETv1.0.0

Get Warehouse By Id

Retrieve warehouse data based on the warehouse ID

Source
actionGETv1.0.0

List Carriers

List all carriers that have been added to this account

Source
actionGETv1.0.0

List labels

This endpoint returns a list of labels that you've [created](https://www.shipengine.com/docs/labels/create-a-label/). You can optionally filter the results as well as control their sort order and the number of results returned at a time. By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both `warehouse_id` and `carrier_id`

Source
actionGETv1.0.0

List Manifests

Similar to querying shipments, we allow you to query manifests since there will likely be a large number over a long period of time.

Source
actionGETv1.0.0

List Scheduled Pickups

List all pickups that have been scheduled for this carrier

Source
actionGETv1.0.0

List Warehouses

Retrieve a list of warehouses associated with this account.

Source
actionPUTv1.0.0

Parse an address

The 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 code, and more. Data often enters your system as unstructured text (for example: emails, SMS messages, support tickets, or other documents). ShipEngine's address-recognition API helps you extract meaningful, structured data from this unstructured text. The parsed address data is returned in the same structure that's used for other ShipEngine APIs, such as address validation, rate quotes, and shipping labels. > **Note:** Address recognition is currently supported for the United States, Canada, Australia, New Zealand, the United Kingdom, and Ireland.

Source
actionPOSTv1.0.0

Purchase Label

Purchase and print a label for shipment

Source
actionPOSTv1.0.0

Purchase Label with Rate ID

When retrieving rates for shipments using the `/rates` endpoint, the returned information contains a `rate_id` property that can be used to generate a label without having to refill in the shipment information repeatedly.

Source
actionPOSTv1.0.0

Purchase Label with Shipment ID

Purchase a label using a shipment ID that has already been created with the desired address and package info.

Source
actionPOSTv1.0.0

Schedule a Pickup

Schedule a package pickup with a carrier

Source
actionPOSTv1.0.0

Start Tracking a Package

Allows you to subscribe to tracking updates for a package. You specify the carrier_code and tracking_number of the package, and receive notifications via webhooks whenever the shipping status changes.

Source
actionPUTv1.0.0

Update Tag Name

Change a tag name while still keeping the relevant shipments attached to it

Source
actionPOSTv1.0.0

Validate An Address

Address validation ensures accurate addresses and can lead to reduced shipping costs by preventing address correction surcharges. ShipEngine cross references multiple databases to validate addresses and identify potential deliverability issues.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

Request a providerRead the actions docs
acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec