Shipwell API

The Shipwell Developer Hub

Welcome to the Shipwell developer hub. You'll find comprehensive guides and documentation to help you start working with Shipwell API as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    API Reference

December 11, 2020

In our final release before 2021, additional automation has been added to the Shipwell platform. These changes help logistics managers manage risk, give a better customer experience, and assist with logistic execution.

Carrier status changes recorded carrier details

Shipwell now tracks the last time the carrier status is changed in the Carrier Details screen. The Date and User who made the status change will be recorded and displayed just below the Carrier Status field.

Add ad hoc email address to Shipments

When using the Quick View Shipment Contacts option to send email communications to any contact points on the shipment, the user can now add additional email addresses not currently associated with the shipment.

Custom stop fields and order name on Order Bulk Import tool

Custom stop data and order names are now included in the bulk import tool. If these information fields are provided as part of the import tool, the data will populate the order form upon creation.

For the stop custom data to map correctly, the column headers of the import for those fields must be added to the template and labeled:

  • PU
  • DEL

Shipment request - Change company

If a company has customers (Manage > Customers), the user initiating a shipment request will now have the ability to select the customer for which the request should be created.

When the Request Shipment link is selected, and the modal is displayed, companies with companies will see a drop-down allowing them to select from their customers' list.

Add orders modal refactor

The orders modal that displays when you select to add orders to an existing shipment has been improved to provide more information allowing for a better-informed decision.

The list of orders displayed when you click Add Order from an existing shipment has been filtered so that only unassigned orders are presented.

The updated modal includes:

  • Order Number
  • Order Name
  • Customer
  • Supplier
  • Origin
  • Destination

The functionality provided with the new modal:

  • You can select one or more orders by clicking on the check box to the left of the desired order
  • You can sort all columns of data
  • You can search for orders using the search field

Updates to routing guide emails

Routing Guides may include Email actions as part of their workflow to alert people at certain points while processing the Routing Guide.

Typical uses are to email someone when a Routing Guide is first triggered if a primary did not take the load or when a guide completes and no carrier is assigned.

With this release, those emails - whose messages are user-defined - now include a reference to the Shipment that triggered the emails and a link back to it. This allows recipients to know exactly which Shipment was associated with the guide and easily open it up to view progress or tag action.

Update Stop Events

New Stop Events are added to the available actions that may occur on a Stop.

Currently, these will only be added to a Stop manually by selecting it from the available Stop Events but automatically trigger Timeline Events for a full audit trail.

The new Stop Events included:

  • Carrier Removed from Shipment
  • Actual Arrival Time Updated
  • Completed Time Updated
  • Detention Loading
  • Detention Unloading

Bug fixes

  • Renaming saved dashboards for managing purchase orders: A bug has been corrected to display two forms when a user attempted to rename a saved dashboard. We now display only one, consistent with our design framework.

  • Line item weight not displaying in dashboard tooltip: Before this release, the items' weight was not populating the Items modal. Now, the items modal displays as a dashboard tooltip.

Updated about a month ago

December 11, 2020


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.