FreightWise Public API

FreightWise offers an Application Programming Interface (API) which is software that allows FreightWise and another party to interact with each other without any user intervention. The use of these APIs provides products or services to communicate with other products and services without having to know how they're implemented.

The APIs consist of a payload which is the part of transmitted data that is the actual intended message. For example, the payload to FreightWise may be the Shipment data that a customer wants to create in the FreightWise TMS to manage. Another payload would be a response to the customer with Cost & Transit data for the Shipment.

Benefits for using the APIs:

  • Standardized FreightWise Objects
  • No associated FreightWise Integration development cost
  • Backward compatibility as versions are released with new functionality
  • The JSON format allows dynamic data import
  • Provides near real-time integration with the FreightWise TMS

A link to our technical documentation of the public api is here (v1.0.1).

Quotes

The 'Quotes' method is used to return Quotes/Rates for available carriers, services, costing, and transit times where Carrier Contracts are stored in FreightWise.

Use Case for using this method - if FreightWise has the freight and/or parcel contracts stored under the client then a customer could use the Quotes API to return rates back.

Using this method know that there is no Shipment Management within FreightWise or Integration.

POST Quotes - /quotes/freight/

This is used to request and return a freight (LTL) Quote/Rate

When a customer wants to request LTL rates from and return into a 3rd party system, ERP, e-commerce, or similar originating point this API will provide a response with Quotes/Rates based on Contracts stored in the FreightWise TMS.

GET Quotes - /quotes/freight/{findByValue}/

Used when a customer wants to request details on an existing Quote/Rate in the system. These are found by the unique id that is assigned when a Quote/Rate is created and returned as a part of the Response in the POST Quotes.

POST Quotes - /quotes/parcel/

This is used to request and return a Parcel Quote/Rate

When a customer wants to request Parcel rates from and return into a 3rd party system, ERP, e-commerce, or similar originating point this API will provide a response with Quotes/Rates based on Contracts stored in the FreightWise TMS.

Shipments

The 'Shipments' method is working with a Shipment object which is a generic form of Shipping Parcel, LTL, and TL.

If a customer wants to manage their shipments in FreightWise they would use the Shipment API. This allows the customer to create the Shipment in FreightWise and log in to manage Shipments through the full life cycle. A webhook (callback) can be triggered at specified state changes to provide data (Carrier, Cost, etc.) back to their system (response payload of data).

POST Shipments - /shipments/

The POST Shipments is used to Create a New Shipment in the FreightWise TMS.       

GET Shipments - /shipments/{findByValue}/

The Get Existing Shipments is used when a customer wants to return the Shipment data. It represents a snapshot of the Shipment data at the time of Request/Response.

FreightWise also provides the ability to find Shipments using other fields, though with the exception of id are not required to be unique within the Shipments. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that matches your criteria.

Types

  • id
  • packNum
  • poNum
  • soNum
  • custNum
  • delvNum
  • freightInvoiceNum

In Conjunction with the GET Shipments, the concept of Webhooks/Callbacks is used which provides a response payload of data. This allows for a triggered response to the customer based on a state change on the Shipment.

PUT Shipments - /shipments/{findByValue}/

The PUT is used to update data on an Existing Shipment in the FreightWise TMS.

The PUT Shipments can be used to match on Shipments with other fields, with the exception of id are not required to be unique within the Shipments. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that matches your criteria.

Types

  • id
  • packNum
  • poNum
  • soNum
  • custNum
  • delvNum
  • freightInvoiceNum

DELETE Shipments - /shipments/{findByValue}/

Cancel an Existing Shipment. This updates the Shipments state to 'Cancelled'

The PUT Shipments can be used to match on Shipments with other fields, with the exception of id are not required to be unique within the Shipments. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that matches your criteria.

Types

  • id
  • packNum
  • poNum
  • soNum
  • custNum
  • delvNum
  • freightInvoiceNum

BOLs

The 'BOLs' method is working with a BOL object which is primarily used for LTL, and TL.

If a customer wants to manage their BOLs in FreightWise they would use the BOL API. This allows the customer to create the BOL in FreightWise then log into FreightWise TMS and manage BOLs through the full life cycle. A webhook can be triggered at specified state changes to provide data (Carrier, Cost, etc.) back to their system (response payload of data).

POST BOLs - /bols/

The POST BOLs method is used to create a New BOL in the FreightWise TMS.

GET BOLs - /bols/{findByValue}/

The Get Existing BOLs is used when a customer wants to return the BOL data. It represents a snapshot of the BOL data at the time of Request/Response.

FreightWise also provides the ability to find BOLs using other fields, though with the exception of id are not required to be unique within the BOLs. Therefore if you are finding by one of those fields other than id FreightWise will return the most recent MAX(id) of the object that matches your criteria.

Types

  • id
  • packNum
  • poNum
  • soNum
  • custNum
  • delvNum
  • freightInvoiceNum

In Conjunction with the GET BOLs, the concept of Webhooks/Callbacks is used which provides a response payload of data. This allows for a triggered response to the customer based on a state change on the BOL.

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.