FAQ - Shipment API

What are Shipments?

In FreightWise Shipments are the object used to represent and form generic movements that ship Parcel, LTL, and TL.

 

How do I create a new Shipment?

When using the FreightWise Public API the POST method is used. For additional details and full schema reference the Swagger Document.

 

What is the minimum required fields to create a Shipment in FreightWise?

The minimum properties are below. We also recommend sending over a PO, SO, or one of the unique IDs available in the reference section.

component property description example
~ shipDate Shipment date, timezone is considered central 2021-06-29
from name1 Location Name

FreightWise, LLC

address1 Location Address

214 Centerview Dr.

city Location City Brentwood
state Two (2) letter state/province abbreviations TN
postalCode In the USA it would be 37027 or from Canada, it would be G0S2H0. Please make sure to remove space between the FSA and LDU. 38017
country USA, CAN, or MEX USA
to name1 Location Name

FreightWise, LLC

address1 Location Address

214 Centerview Dr.

city Location City Brentwood
state Two (2) letter state/province abbreviations TN
postalCode In the USA it would be 37027 or from Canada, it would be G0S2H0. Please make sure to remove space between the FSA and LDU. 38017
country USA, CAN, or MEX USA
~ directionId

The direction ID designates the direction. The following are the options:

  • 1 = Inbound
  • 2 = Outbound
  • 3 = Third Party
  • 5 = Transfer

By default, it is 1 = Inbound.

1

~ termId

The following term IDs are vaild for this API:

  • 9 = PPD - PrePaid
  • 10 = COL - Collect
  • 12 = Third Party
  • 13 = PPA - PrePaid & Add

9

~ modeId

The following mode IDs are vaild for this API:

  • 1 = LTL
  • 2 = TL
  • 4 = Ocean
  • 5 = Rail
  • 7 = Air (Freight)
  • 8 = Hotshot
  • 9 = Local
  • 10 = Drayage
  • 18 = Parcel
  • 22 = White Glove

1

commodities name Commodity Name

Rope, Synthetic Fiber

partNum Commodity Part Number 1237902736291
nmfcClass NMFC Class designation. Your less-than-truckload (LTL) freight shipping class is a number established by the National Motor Freight Classification (NMFC). It's also known as your NMFC classification or NMFC code. 70
weight Weight in Pounds (LBS) of the Shipment 123.45

 

What if I already know the Carrier that we want to use, how do I pre-assign the Carrier?

The Carrier should be identified in the 'scac' property using the Carriers assigned SCAC.

 "scac": "ODFL",

Standard Carrier Alpha Code (SCAC) is a unique two-to-four-letter code that is used to identify transportation companies.

 

How does FreightWise handle automatically quoting/rating Shipments?

A Company Setting can be set during Implementation to 'Allow Auto Rating' which will take the Shipment data imported in the POST, send it to the Rater via a rating request, and save Carrier Quote(s) in order of Least Cost Carrier on the newly created Shipment.

 

When can I expect to receive a response?

When a state change occurs in FreightWise you will receive a response.

The technical details FreightWise Public API is a RESTful API that uses a concept called a webhook or callback to provide a response. A webhook (callback) can be triggered at specified state changes to provide data (Carrier, Cost, etc.) back to your system (response payload of data).

 

If there is an error in the data I sent how am I notified?

FreightWise responds with a standard 400 code.

 

For additional details, you can reference the FreightWise Public API article.

 

 

 

 

 

Have more questions? Submit a request

0 Comments

Article is closed for comments.