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

May 27, 2020

Enhancements made to the Shipwell platform help customers increase efficiency and value in their supply chain.

Custom carrier invoice instructions

The Company page has been updated to create a page specific to Carrier Instructions. Navigate to Company and select Carrier Instructions. This link was previously called Credit & Terms.

From the Carrier Instructions, there's now a section for Billing and a second section for Rate Confirmation. Under Rate Confirmation, shippers now have the option to use the default invoicing instructions that show up on the Rate Confirmation document today or create their own custom instructions.

Change company during consolidation

Users can now change the company that is tied to an order during the consolidation process.

If a company does not have customers assigned to it, no changes to the order consolidation flow will be presented and the user will not be able to change the name of the company associated with the order.

However, if a company has one or more customers assigned to it, the order consolidation workflow has been updated allowing users to change the company that is tied to an order.

After selecting orders to be consolidated and clicking ‘Create Shipment’ or ‘Create Quote’, the user will see the following modal:

Clicking on the dropdown exposes all of the customers associated under the host company. Selecting a name from the list will apply that company to the order and ultimately the shipment. Users can search for a name by typing in the field.

Expand upload document formats

Users can now upload a document in one of the following field formats:

  • txt
  • csv
  • xls
  • xlsx
  • doc
  • docx
  • odf
  • pdf
  • jpg
  • jpeg
  • svg
  • png

Bulk import updates

The bulk import tool can import spreadsheets and CSV files more easily.

Automated field matching

Columns in a customer-provided spreadsheet are automatically matched with Shipwell fields reducing the time to map data. Additionally, the sample, downloadable CSVs contain columns that match all possible Shipwell fields.

If a customer downloads and uses our provided template, no mapping is necessary.

Location reference numbers for orders

  • Enter a Customer ID or Supplier ID in a spreadsheet/CSV used in the Bulk Import tool automatically imports location information without having to include those fields on every order.

  • Enter a Customer ID and/or Supplier ID matches with an External Reference entered on an Address Book item. The resulting order imports the Origin and/or Destination location information directly from the Address Book.

  • Enter a Customer ID and/or Supplier ID while adding details to some of the spreadsheet fields initially import location details from the Address Book then override the fields with data entered in the spreadsheet.

Automated call updates

Updates to the Automated Calling feature to provide a better experience once Check Calls are made displaying the call history and events.

Minor UI/UX updates

Icons were updated to display properly on the call log and better aligned to describe the types of events.

Also, “Check Call In Progress…” automatically updates to “Check Call Made” after a call completes without refreshing.

Call log

A log of past and scheduled calls were only displaying while calls were in progress. Now the log is displayed permanently on the Automated Calls tab of the Timeline panel.

Scheduled calls can be edited to change the scheduled time or deleted.

Past calls can be listened to which is particularly important if a location could not be understood by the system.

Timeline events

After a call is made, a Location Updated event is added to the Timeline displaying the time and location retrieved from the call. If no location was understood, the event displays that information.

If there is a change to the ETA, an ETA Changed event is also added to the timeline.

Carrier status


The addition of a Carrier Status field to in-network carriers provides a Logistics Manager or 3PL Compliance Administrator with the ability to turn on and off specific carrier companies from their logistics operations, depending on business policies.

Every in-network carrier is now shown with a Carrier Status field, containing three possible values: Active, Inactive, and Do Not Use. This value restricts Inactive and Do Not Use carriers from taking certain actions on the platform, per the following table:

Carrier management

On the Manage > Carriers page, Carrier Status appears both on the Carrier List and Carrier Details pages.

Carrier status on shipments

An alert on the Shipments page surfaces possible compliance risk conditions to a Logistics Manager. For example, any cases where a Do Not Use carrier is associated with a Shipment, as can occur if the association was made when the carrier was formerly in Active status, causes an alert.

Inactive carriers are shown to a Logistics Manager but cannot be added to a Tender offer. They can participate in a bid request, but their submitted bids cannot be selected for shipment until that carrier's status is changed to active.

Get connected section added to docs

Revamped the “Getting Started” portion of our API documentation to help developers get connected themselves through postman and cURL.

Bug Fixes

Account rep not transferring to Shipment

On the Shipment details page, both the Sales Rep and Account Rep now display in the References section.

Account not active message from magic link

If a user does not have an active account and is sent a magic link via email, rather than just being prevented access without clear messaging, the user now sees the following:

Tracking link sent for shipment with no location updates

Previously, when a tracking link was sent for a shipment that did not have location updates, the user would see white space for Last Location.

Now, when the shipment does not have location updates, the user sees:

Line Item totals should always display

When adding a new Line Item for a shipment, the total for all Line Items is retained even when creating a new item.

Updated 6 months ago

May 27, 2020

Suggested Edits are limited on API Reference Pages

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