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

September 30, 2020

This major release adds a new platform integration, as well as various enhancements and bug fixes.

NetSuite integration

Shippers and brokers can now connect their NetSuite account system to Shipwell's platform to generate and sync vendors, customers, bills, and invoices, automating the transfer of information on delivered shipments to initiate payments and collections.

Through the integration marketplace, you can establish a secure connection to your Netsuite hosted tenant and map line items in our shipment records to fields in Netsuite.

Once complete, a user can generate invoices and bills directly from the platform. This allows you to select which line items and documents to include within Netsuite. After the bill or invoice creation, you will have the option to share the generated documents with internal and external stakeholders.

For instructions on integrating NetSuite with Shipwell, see NetSuite.

Display custom reference fields on documents and emails

If a company has defined custom reference fields, those fields will display on all documents and emails. The fields will only show if the fields are populated.

The company can define custom reference fields from Company > Custom Data. A custom field can be included in the following sections:

  • New shipments
  • Shipment details
  • BOL
  • Rate confirmations
  • Shipment status notifications

EDI (214): stop status on shipments

When shipment updates occur via a 214, the stop statuses of that shipment should be updated when the following actions occur:

  1. Carrier has accepted tender and is assigned to a shipment
    • No stop event needed
    • Shipment status = Tendered
  2. Code AJ received (Tendered for Delivery)
    • No stop event needed
    • Shipment status = Tendered
  3. Code X5 (Arrived at Delivery Location Loading Dock)
    • If X5 is sent with an index indicating which stop it pertains to, a stop event will be added: Arrived Delivery Loading Dock
    • Shipment status = In Transit
  4. Code X6 = En Route to Delivery Location
    • A stop event will be added: En Route to Delivery
    • Shipment status = In Transit
  5. Code X3 (Arrived at Pick-up Location)
    • A stop event will be added: Arrived at Stop
    • Shipment status = At pickup (if first stop) or In Transit (if different stop)
  6. Code X1 (Arrived at Delivery Location)
    • A stop event will be added: Arrived at Stop
    • Shipment status = In Transit
  7. Code AF (Carrier Departed Pick-up Location with Shipment)
    • A stop event will be added: Pickup Completed
    • Shipment status = In Transit
  8. Code CD (Carrier Departed Delivery Location)
    • A stop event will be added: Delivery Completed
    • Shipment status = Delivered
  9. Code CA (Shipment Canceled)
    • No stop event needed
    • Shipment status = Canceled

Loadboard and dashboard origin and destination filters

Loadboards and dashboard filter updates improve logic and naming to represent better how filters should be used:

  • The Origin Address filter is now called Pickup Address, which searches all stops marked as pickup.
  • The Destination Address filter is now called Delivery Address, which explores all stops marked as delivery.

Shipment accessorial placement and clarity

Shipment and stop accessorials are no grouped in one field.

  • Side Panel: Find stop accessorials with the stop to which they pertain. Similarly, find shipment accessorials underneath the last stop.
  • Shipment dashboard: The shipment dashboard now contains a shipment accessorials column. The column displays the number of accessorials applied to the shipment and must be activated to be seen. Hover over the number to see accessorial.
  • Filters: Users now filter by shipment accessorials using the shipment accessorials dropdown menu.
  • Request bid modals and emails: Request bids modals and emails now display stop accessorials under the associated stop. Shipment accessorials show under the last stop.

Display person that created a shipment

The name of the individual who creates a shipment now displays on the shipment details page.

The 'source' or method used to create a shipment, if not entered manually by a user, will also be displayed. Create shipments via the following sources:

  • Shipment Request
  • EDI
  • API

Pricing intel identifies outlier data

Pricing intel now scans a company's historical data (My Data) to identify outlier data. When data identifies an outlier, both the Pricing Intel Graph and My Data table label said outlier. (Outlier identification only considers My Data; it does not apply to historical Market Data or Predictive Pricing.)

When one or more outliers are present, the Pricing Intel Graph removes the outlier scatter point(s) from the graph, automatically rescales the y-axis for optimal viewing, and calls out the point(s) in the upper-right of the chart. Hovering over the outlier icon reveals the date(s) and price(s) associated with the outlier(s).

Minor notification improvements

Notifications improvements include:

  • Automatically generate an email notifying the carrier when a shipper removes the carrier from a shipment.

  • When shipment cancellation is sent to the carrier, ensure the email is sent to the carrier point of contact assigned to the shipment and not to the carrier's administrative contact.

Bug fixes

  • Correct vendor displays during a shipment request's manual book option.
  • All supported excessive length accessorials map to a common accessorial to ensure proper rating occurs.
  • The capability of shipment LTL rating to retrieve PRO numbers now expands to custom tariffs.
  • P44 on LTL loads now coordinates with ETA dates when loads are updated.
  • Financials cards no longer crash when transferring a shipment to another vendor.

Updated 3 months ago

September 30, 2020

Suggested Edits are limited on API Reference Pages

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