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

June 24, 2020

New features and enhancements increase the depth of the Shipwell platform.

Clone routing guides

Shippers are likely to create several similar routing guides making minor adjustments to cover all cases. Cloning existing routing guides allows shippers to produce multiple with less data entry quickly.

From either a specific routing guide or from the master list of routing guides, a shipper can make a copy and change what is needed before saving.

Additionally, if a shipper wanted to create multiple routing guides in a row, checking Create Clone after Saving automatically creates a modifiable copy.

Additionally, if a shipper wanted to create multiple Routing Guides in a row, checking Create Clone after Saving automatically creates a copy that can be modified as necessary.

Clone SLAs

Shippers may also create several, similar SLAs making minor adjustments to cover all cases. Cloning existing SLAs allows shippers to produce multiple with less data entry quickly.

Similar to Contracts and Routing Guides, cloning can be executed from a specific SLA’s detail screen or the master list of SLA’s.

Additionally, if a shipper wanted to create multiple SLAs in a row, checking Create Clone after Saving automatically creates a copy that can be modified as necessary.

Enable Drayage on Routing Guides and Contracts

Both Routing Guides and Contracts now support Drayage. Previously, only FTL was supported. No functional changes or Drayage-specific additions were made, and the same approach to creating and executing can be expected.

Carrier status enhancements

Inactive carriers on load board

Inactive carriers can not attempt to acquire a Load from the Load Board using Book Now. Before this change, an Inactive carrier was able to try to use Book Now but would receive an error message stating that ‘Carrier Status must be Active.’ With this update, the Book Now button is disabled for Inactive carriers viewing the Load Board. Note that an Inactive Carrier can submit a bid on the Load Board, but cannot fully acquire the Load until that carrier’s status changes to Active.

Dispatch and tracking

Remove tracking field from each Power Unit card

The tracking field has been removed from each Power Unit card on the Assets tab. This field was redundant with the Power Unit number shown in the header of the field and was displaying the UUID corresponding to that Power Unit.

ELD tracking improvements for Keep Truckin Carriers

  • When a Keep Truckin carrier initiates tracking with Shipwell from within the Keep Truckin portal, this now (i) automatically assigns Keep Truckin as the ELD provider for that carrier within Shipwell’s Administrative Console, and (ii) starts the flow of ELD data for that carrier. This change eliminates the need for Shipwell to take action to onboard that carrier within a brief 10-minute window following the initiation of this action within the Keep Truckin portal.

  • When a Keep Truckin carrier selects and installs the Shipwell app listing within the Keep Truckin portal’s marketplace, this will onboard that carrier within Shipwell’s Admin Console with Keep Truckin identified as the ELD provider for the carrier.

Bulk import carriers

Shippers can now import their carrier lists using the Bulk Import utility. Previously, adding carriers to the platform required defining each carrier individually. If the carrier had not entered their data in MyCarrierPackets, an admin could start with a USDOT or MC# lookup from FMCSA or start from scratch and enter all details themselves.

With the Bulk Import tool, importing multiple carriers in one bulk action is now available - which is necessary if a new customer brings an existing list of carriers.

An FMCSA lookup happens automatically (injecting most of the carrier data) with additional fields available to enter details not found in FMCSA like contacts and the carrier owner.

From Manage > Carriers, a user can launch the Bulk Import utility similar to Contracts, Purchase Orders, Address Book, and Products.

Likewise, either a local CSV to upload or public-facing Google Sheet is required. A template CSV is available here but can also be downloaded straight from the tool.

Remember the following when using the bulk import tool:

  • All carriers require USDOT. Re-importing the same carrier to update certain fields can be accomplished if the USDOT is found in a carrier on the platform.

  • Status automatically sets to active if not supplied but can also be set to inactive if preferred. If re-importing a carrier, the status will be overridden with the new value or will not change if blank.

  • Carrier owner can be defined by adding an email of a user of the company. If re-importing a carrier, the owner will be overridden with the new value or will not change if blank.

  • Tags can be supplied in a comma-delimited list (e.g., “one, two, three”). If re-importing a carrier, the tags will be appended with any new tags or will not change if blank.

  • You can add Notes. If re-importing a carrier, the notes will be overridden with the new value or will not change if blank.

  • Contacts are added one per row. If multiple contacts are needed for the same carrier, multiple rows will be required using the same USDOT.

  • You cannot otherwise update or delete information on the carrier through the importer.

Bug Fixes

Shipment totals incorrectly converting imperial to metric

If a user included non-imperial measurements when defining line item characteristics (dimensions and weight), the conversions to go from imperial to metric were incorrect, causing inaccurate shipment line item totals. Now shipments can contain line items with both imperial and metric measurements and display the values based on the user’s preferences.

With this change, the shipment totals use the following criteria:

  • If metric is used for weight and DIMS, shipment line item totals display as metric
  • If imperial is used for weight and DIMS, show shipment line item totals in imperial
  • If mixed measurements are used, always default the totals to the Company Country Setting

Temperature Range Consistency

Users can now enter the same value for temperature min/max. Min/max temperatures now appear on BOL and Rate Confirmation line items that require them.

Temperature fields adjust based on country setting

Temperature measurements which display on both BOL and Rate Confirmation documents now reflect the country preference for the account: “F” for the United States and “C” for Canada.

Updated 26 days ago

June 24, 2020


Suggested Edits are limited on API Reference Pages

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