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 13, 2020

What's new at Shipwell

Visibility is a crucial area of the platform where shippers and 3PLS alike hone in on tracking their shipments and orders. Automated Tracking Calls are now available to all customers adding to our already available ELD, Mobile, and Manual options. This gives shippers and 3PLs alike a plethora of tools to make sure they can track shipments for customers and manage exceptions in a timely manner.

Automated tracking calls

Automated Calls help Transportation Managers and Reps track shipments by having a driver verbally indicate their location when other mechanisms might not be available.

Calls can be scheduled ahead of time or initiated immediately.

This feature is available to all existing customers but can be toggled on and off. Find the company preference toggle on the Company Profile screen (Manage > Company > Profile).

Address book details shipment consolidation

When using an address book entry to create an order and that order consolidated into a quote or shipment, the details of that are address book at now applied to the shipment or quote, reducing the amount of manual entry.

The fields applied to a shipment and quote:

  1. Location Type
  2. Pickup Accessorials
  3. Appointment Type
  4. Start Time
  5. Stop Time
  6. Instructions
  7. Contact First Name
  8. Contact Last Name
  9. Contact Email
  10. Contact Phone

The fields applied to a quote are:

  1. Location Type
  2. Pickup Accessorials
  3. Appointment Type
  4. Ready At
  5. Closes At
  6. Instructions
  7. Contact First Name
  8. Contact Last Name
  9. Contact Email
  10. Contact Phone

Routing guide SLA filters

Filters have now be added to the master list of Service Level Agreements (SLAs). Navigate to Manage > Routing Guides and select the SLAs tab on the left navigation.

Shippers can narrow down a subset of SLAs based on:

  • Status (Active, Inactive)
  • Service Level Rank (Primary, Secondary, Tertiary, Backup)
  • Effective Start and End Dates (Calendar Picker > Before, After, Between)

The individual filters function consistent with other areas of the platform, including single or multiple values, searching before, after, or between dates, and clearing selections.

Support for locations without zip codes

Locations entered into routing guides, contracts, and bid manager no longer require zip codes allowing Load Planners and Transportation Managers the ability to add cities, towns, or states by themselves.

In these cases, locations do not necessarily need to be as specific as they are on a shipment. Allowing zones like cities, towns, and states to be defined simplifies data entry and extends the flexibility of planning as these tools may be applied to various shipments within a defined zone but with different addresses.

Order page improvements

The following improvements have been made to the user experience:

  • Updated the header so that the status of the order is closer to the order rather than being in the middle of the page.
  • Placed the delete icon in the line item summary box, reducing the number of clicks required for access.
  • Users can now open item details by clicking anywhere on the line item summary box.
  • If the description of a line item exceeds 25 characters, the remaining characters become hidden until expanded.
  • When using address book entries to create an order, the Company Name defined for the entry now auto-populates the supplier and customer name fields.
  • Images can now be dragged into the save product box when saving a product.

BOL generation from manual shipment without carrier

The BOL logic has been updated removing the requirement that a carrier is assigned to a shipment in order to generate a BOL.

Now, if a manual shipment is being created and the carrier is unassigned, the user still has the ability to generate a BOL by clicking Schedule Pickup & Print BOL.

Search and filter by parcel status

Searching for Parcel shipments in Open and Delivered status now produces results.

Andriod 3.2.3

Minor bug fixes and improvements. More specifically, this release included changes to the underlying navigation model, with no impact on user-facing functionality.

Bug Fixes

Clarify required custom fields

The error that displays when a required custom reference field the Shipment Status is empty is more user friendly. The error now specifies which required custom field is required.

Remove a carrier from a shipment

Corrected an error where if a user attempted to update a line item for an existing shipment, the shipment would present an error saying quantity was required even if there was a value for the quantity entered.

Line Item density calculation

The calculation formerly used for Total Density was incorrect, causing density to be too low, which miscategorized the freight class and affected the LTL rates. The calculation now uses the correct density and freight class for LTL rates.

The freight class of a shipment line item is based on the density of the item according to the following schedule:

New density class calculations

For every item on a shipment, an estimated freight class is calculated based on the values entered on the item. Weight and dimensions are based on a single “piece” on the line item without regard to Quantity. A line item includes values for Package Weight, Length, Width, Height, and Units (i.e., IN or CM) – referring to the size and weight of a single piece.

The volume on an individual piece in the line item is calculated as its length width height / 1728 (if dimensions are in inches) or length width height / 28316.8 (if dimensions are in centimeters).

  • Dividing dimensions by 1728 converts cubic inches to cubic feet
  • Dividing dimensions by 28316.8 converts cubic centimeters to cubic meters

The final line item’s density is the piece’s calculated volume / Package Weight and used to look up the Estimated Freight Class.

Updated 6 months ago

May 13, 2020

Suggested Edits are limited on API Reference Pages

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