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

July 8, 2020

This release updates Routing Guides to support per-mile rates and the creation of Routing Guides from contracts and changes to EDI handling.

Shipment id on order list

Users will now see the specific shipment for which an order is associated. Orders that are in Assigned status will display this information on both the order list table as well as the order details.

Clicking on the shipment id link takes the user to the shipment details.

Order list table

Deleted orders assigned to line items disappear

Making changes to an order assigned to a shipment does not update the associated shipment. Users will no longer see the option to add or delete line items to an order once that order is assigned to a shipment.

Order line item delete warning

If a user clicks on the delete icon for a line item within an order, a message displays allowing the user to confirm the delete request.

Saved Dashboards added to order view

Users can now create and save a new dashboard or filter on the Order Dashboard page. After clicking on the filter icon on the Orders page, you will see a new column called Saved.

Users can create a new dashboard selecting one or more options from the filter tab. Manage saved dashboards using the action menu located next to the dashboard name.

Order filter

Filters, new to the Order List page, allow users to filter order results, including a checkbox that filters Only My Orders.

T## Shipment financial line items show multiple decimals

The financial line items on a shipment have been modified to allow multiple decimal places for both rate and quantity.

  • Rate allows up to four decimal places
  • Quantity allows up to three decimal places.

The line item totals and customer total continues to round to two decimal places.

EDI revoked 204 (Tender) handling

If the shipper revokes an EDI tender before tendering, the following actions take place:

  • Tender status moves to tender Revoked
  • The shipment cancels
  • A tender revoked email sends to the Carrier Rep (email exists today)

If an EDI tender has been accepted and then tendered to a carrier, the following actions should take place:

  • Tender status moves to tender Revoked
  • The shipment cancels
  • Tender to the carrier revokes (email exists today)

EDI 204 (tender) inboud update

If an update to an inbound 204 (tender) is received from a shipper, you can now address changes contained within the update. Changes sent via an updated 204 will automatically be applied to the associated shipment or tender, depending upon which state of the 204.

  1. Tender has not been accepted: A comparison of what has changed should be made between the original 204 submission and the updated 204 submissions. If one or more fields have changed, those fields update on the tender request.
  2. Tender rejected: No changes should be made to the tender.
  3. Tender accepted, and a shipment created: Creates a comparison of what has changed between the original 204 submission and the updated 204 submission. If one or more fields change, those fields update the tender request as well as the shipment.

An email will be sent to the Carrier Rep assigned to the account that sent the tender, notifying them that an update to a tender has been received.

The email lists the fields that have changed, including both the old values as well as the updated values.

Suggest contracts based on Routing Guide

Defining tender actions in a Routing Guide now suggests contracts based on how well they match criteria specified in the Routing Guide. For example, Routing Guides used for drayage display matching drayage contracts when used to populate tender actions.

Per-mile tenders convert to flat fee

Tenders can only be sent with flat fee Line Haul rates. Define tender actions on a Routing Guide with per-mile rates in addition to flat fee rates since guides may be planned and leveraged across any number of lanes.

When sending a specific shipment through the Routing Guide to assign a Carrier, tenders are now dynamically rated based on the predefined per mile rate and the shipment's total miles.

The resulting tender includes the required flat fee while minimizing the number of necessary guides since the final rate is determined by the shipment it is applied to when executed.

Create Routing Guides from contracts

You can now generate Routing guides from a set of predefined contracts.

In a typical case, Shippers have several pre-negotiated rates from Carriers through an RFP process or by other means. These rates are then used to help create a Routing Guide along with defining lanes and other necessary details.

Now, a Logistics Manager can filter and sort contracts. To do so, they'll need to select contracts that meet their objectives, and immediately generate a Routing Guide that constructs the lane, details the mode and equipment criteria and creates the necessary rated tender actions based on the Carriers associated with the Contracts.

Andriod v3.2.6

The mobile app now displays either the Total Weight of a shipment/load when the web app supplies the total weight. Alternatively, you can calculate total weight as the sum of individual line items.

Bug fixes

Error when selecting piece type

Fixes an error occurred when selecting either Package or Floor Loaded for piece type.

Correct verbiage on Tender Accepted Email

Fixes an error when tender acceptance emails were previously labeling the Pickup as Stop 2.

New user if email already exists

Duplicate email addresses were creating issues when users were attempting to bid on shipment, view loads on the load board, etc. Now users cannot be created if using the same email address that already exists within the platform.

Update carrier contact email addresses

There was a bug in the system that created an additional POC if the email address of an existing POC was changed. Now a current POC’s email address is changed, only the email is updated. No additional POCs are created.

Updated 6 months ago

July 8, 2020

Suggested Edits are limited on API Reference Pages

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