Freightview API

Suggest Edits

Getting Started with Freightview API

This page will help you get started with Freightview API. You'll be up and running in a jiffy!

 

The Freightview API is designed under the principles of REST. It features predictable URLs that are focused on resources and their actions. We also take advantage of HTTP's built-in features, such as HTTP verbs and HTTP authentication. All responses to the Freightview API are returned in JSON. You must have an active subscription to Freightview to use the API.

The Freightview API can feature multiple versions, all of which are accessible at any time by appending the version number to the base endpoint. When backwards incompatible changes are made, a new version will be released and will be noted on your API settings page.

Authentication

Freightview API authentication is handled by passing your API authentication key in the username field for HTTP basic auth. You do not need to supply a password, just the key. All API requests must be transmitted over HTTPS.

Endpoints and Testing

The URL above is used for integrating with a back-end system. You can't get to the Freightview API by clicking on the link in a browser. To test your authentication and API calls, we recommend using cURL, a utility for testing network requests. You can find more information about it here: http://curl.haxx.se.

A Freightview blog post is available containing detailed instructions on testing the API with cURL or Postman.

Suggest Edits

/authenticate

Test authenticating with Freightview using your api keys.

 
gethttps://www.freightview.com/api/v1.0/authenticate
curl -u <api_key>: -X GET https://www.freightview.com/api/v1.0/authenticate
var request = require("request")

var options = {
  method: "GET",
  url: "https://www.freightview.com/api/v1.0/authenticate",
  auth: {
    "user": "<api_key>"
  }
}

request(options, function (err, res, body) {
  if (err) throw err
  console.log(res.statusCode + ": " + body)
})
A binary file was returned

You couldn't be authenticated

<your_email> successfully authenticated.
// empty body
 

Note the colon at the end - this tells curl to ignore the empty password.

API Key

You can find your API key under the gear menu from within Freightview.

Suggest Edits

/rates

Get freight rates by creating a new rate object. Given a set of shipment attributes as input, Freightview will send back a list of rates.

 
posthttps://www.freightview.com/api/v1.0/rates
curl -u <api_key>: -H "Content-Type: application/json" -X POST -d '{
  "pickupDate":"2018-02-14",
  "originPostalCode":"30303",
  "destPostalCode":"60606",
  "items":[{
    "weight":500,
    "freightClass":50
  }]
}' "https://www.freightview.com/api/v1.0/rates"
var request = require("request")

var options = {
  method: "POST",
  url: "https://www.freightview.com/api/v1.0/rates",
  auth: {
    "user": "<api_key>"
  },
  headers: {
    "content-type": "application/json"
  },
  json: {
    "pickupDate": "2018-02-15",
    "originPostalCode": "30303",
    "originType": "business dock",
    "destPostalCode": "60606",
    "destType": "residential",
    "items": [
      {
        "weight": 500,
        "freightClass": 50,
        "length": 48,
        "width": 48,
        "height": 48
      }
    ],
    "charges": [
      "liftgate pickup"
    ]
  }
}

request(options, function (err, res, body) {
  if (err) throw err
  console.log(body)
})
{
  "pickupDate": "2018-02-14",
  "originPostalCode": "30303",
  "originType": "business dock",
  "destPostalCode": "60606",
  "destType": "residential",
  "items": [
    {
      "weight": 500,
      "freightClass": 50,
      "length": 48,
      "width": 48,
      "height": 48
    }
  ],
  "charges": [
    "liftgate pickup"
  ]
}
<?php
$url='https://www.freightview.com/api/v1.0/rates';
$token = "<api_key>";

$shipment = array(
  'pickupDate' => "2018-02-12",
  'originPostalCode' => "30303",
  'destPostalCode' => "60606",
  'items' => array(
    'weight' => 500,
    'freightClass' => 50
  ));
  
$data = json_encode($shipment);
$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_USERPWD, "$token:");
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data))
);

$json = curl_exec($curl);
echo $json
?>
A binary file was returned

You couldn't be authenticated

{
  "id": "570665116d0afce422911667",
  "pickupDate": "2018-02-14",
  "originPostalCode": "30303",
  "originType": "business dock",
  "destPostalCode": "60606",
  "destType": "residential",
  "billPostalCode": "30303",
  "items": [
    {
      "weight": 500,
      "freightClass": 50,
      "length": 48,
      "width": 48,
      "height": 48,
      "hazardous": "false",
      "pieces": 1,
      "package": "Pallets_48x48"
    }
  ],
  "charges": [
    "liftgate pickup"
  ],
  "rates": [
    {
      "id": "570665116d0afce422911668",
      "status": "ok",
      "paymentTerms": "Outbound Prepaid",
      "total": "100.53",
      "ref": "123456789",
      "days": 2,
      "serviceType": "standard",
      "carrier": "Example Carrier Inc",
      "carrierCode": "EXCI",
      "charges": [
        {
            "name": "discount",
            "amount": -705.86
        },
        {
            "providerDetail": "Lift-Gate Service (Pickup)",
            "amount": 30,
            "name": "liftgate pickup"
        },
        {
            "providerDetail": "Residential Delivery",
            "amount": 15,
            "name": "residential delivery"
        },
        {
            "providerDetail": "Fuel Surcharge",
            "amount": 37.19,
            "name": "fuel"
        },
        {
            "name": "linehaul",
            "providerDetail": "linehaul",
            "amount": 946.88
        }
      ],
      "bookUrl": "https://www.freightview.com/app/shipment/570665116d0afce422911667/select-rate/570665116d0afce422911668"
    }
  ],
  "links": {
    "ratesUrl": "https://www.freightview.com/app#quotes/570665116d0afce422911667/rates",
    "spotUrl": "https://www.freightview.com/app#spot-quote/570665116d0afce422911667/carriers"
  }
}
{
  "error": "error code",
  "message": "Human readable error message."
}

Query Params

timeout
int32

Specify how long to wait for rates from all carriers (Max: 30 seconds). Specify 1, if you just want to create a quote in Freightview.

Body Params

pickupDate
date

Pickup date for this rate request. If pickup date is omitted or falls on a non-shipping day, the pickup date will be the next available shipping day.

originCompany
string

Company name for the pickup location.

originAddress
string

Address for the pickup location.

originAddress2
string

Address line 2 for the pickup location.

originCity
string

City for the pickup location.

originState
string

Two character state abbreviation for the pickup location.

originPostalCode
string
required

Five character postal code for the pickup location.

originCountry
string

Two character country code for the pickup location.

originType
string

Location type for the pickup. See the list of valid location types.

originContactName
string

Name of a contact person at the pickup location.

originContactPhone
string

Phone number for the contact at the pickup location. (XXX) XXX-XXXX

originContactEmail
string

Email for the contact at the pickup location.

originReferenceNumber
string

Reference numbers for the origin. (ex: Order number)

originInstructions
string

Special pickup instructions.

originDockHoursOpen
string

The time the origin location will be open for pickups in 12-hour format. (9:00 AM)

originDockHoursClose
string

The time the origin location will close for pickups in 12-hour format. (5:00 PM)

destCompany
string

Company name for the delivery location.

destAddress
string

Address for the delivery location.

destAddress2
string

Address line 2 for the delivery location.

destCity
string

City for the delivery location.

destState
string

Two character state abbreviation for the delivery location.

destPostalCode
string
required

Five character postal code for the delivery location.

destCountry
string

Two character country code for the delivery location.

destType
string

Location type for the delivery. See the list of valid location types.

destContactName
string

Name of a contact person at the delivery location.

destContactPhone
string

Phone number for the contact at the delivery location. (XXX) XXX-XXXX

destContactEmail
string

Email for the contact at the delivery location.

destReferenceNumber
string

Reference numbers for the delivery location. (ex: PO number)

destDockHoursOpen
string

The time the destination location will be open for deliveries in 12-hour format. (9:00 AM)

destDockHoursClose
string

The time the destination location will stop accepting deliveries in 12-hour format. (5:00 PM)

destInstructions
string

Special instructions for delivery.

billPostalCode
string

Five character postal code for the billing party. Only used for third party rates.

billCountry
string

Three character country code for the billing party. Only used for third party rates.

charges
array of strings

An array of strings for additional charges. See the list of accessorials.

items
object

items[description]

items.weight
int32
required

Total weight of this item in pounds.

items.freightClass
double
required

Freight class of this item. See list of valid freight classes.

items.length
int32

Length of this item in inches..

items.width
int32

Width of this item in inches.

items.height
int32

Height of this item in inches.

items.package
string

Packaging types for this item. See list of valid packaging types.

items.pieces
int32

Number of pieces in this item.

items.hazardous
boolean

Hazardous materials flag.

items.nmfc
string

NMFC code for the item.

items.description
string

Product description.

 

Dimensions

Item dimensions are optional, however many freight brokers and carriers do not provide their best LTL rates without dimensions. For the best rates, enter dimensions.

Suggest Edits

Rate result

Rates are returned as a list with an entry for each provider and service type combination. The rate response array contains objects with these attributes.

 
Property
Type
Description

id

A Freightview internal identifier for this shipment.

rates[id]

string

A Freightview internal identifier for a specific rate.

rates[status]

string

Status code for this rate. Values can be ok or error.

rates[paymentTerms]

string

Payment terms used for this rate. See the list of payment terms.

rates[total]

double

The total amount of this rate. Includes freight charges, fuel and all additional charges.

rates[ref]

string

A provider-specific reference number. Not all providers send this back.

rates[days]

int

The number of transit days for this rate.

rates[serviceType]

string

The service type for this rate.

rates[serviceOption]

string

Delivery time of day for guaranteed or expedited rates, in 24 hour time.

rates[carrier]

string

The name of the asset-based carrier that will actually move the shipment.

rates[carrierCode]

string

The 4-digit SCAC code of the asset-based carrier that this rate would be moved under. See list of Carrier codes.

rates[provider]

string

The name of the provider or freight broker that supplied this rate. Only returned for freight broker rates.

rates[providerCode]

string

The 4-digit SCAC code of the provider or freight broker that supplied this rate. Only returned for freight broker rates.

rates.charges[name]

string

The short name of the charge (e.g. linehaul, fuel, discount).

rates.charges[amount]

double

The dollar amount of this specific charge.

rates[bookUrl]

string

A direct link to book the shipment with this rate within Freightview.

links.ratesUrl

array

A direct link to access all of the rate results for this shipment within Freightview.

links.spotUrl

string

A direct link to start a spot quote for this shipment within Freightview.

{
  "id": "570665116d0afce422911667",
  "pickupDate": "2018-02-14",
  "originPostalCode": "30303",
  "originType": "business dock",
  "destPostalCode": "60606",
  "destType": "residential",
  "billPostalCode": "30303",
  "items": [
    {
      "weight": 500,
      "freightClass": 50,
      "length": 48,
      "width": 48,
      "height": 48,
      "hazardous": "false",
      "pieces": 1,
      "package": "Pallets_48x48"
    }
  ],
  "charges": [
    "liftgate pickup"
  ],
  "rates": [
    {
      "id": "570665116d0afce422911668",
      "status": "ok",
      "paymentTerms": "Outbound Prepaid",
      "total": "100.53",
      "ref": "123456789",
      "days": 2,
      "serviceType": "standard",
      "carrier": "Example Carrier Inc",
      "carrierCode": "EXCI",
      "charges": [
        {
            "name": "discount",
            "amount": -705.86
        },
        {
            "providerDetail": "Lift-Gate Service (Pickup)",
            "amount": 30,
            "name": "liftgate pickup"
        },
        {
            "providerDetail": "Residential Delivery",
            "amount": 15,
            "name": "residential delivery"
        },
        {
            "providerDetail": "Fuel Surcharge",
            "amount": 37.19,
            "name": "fuel"
        },
        {
            "name": "linehaul",
            "providerDetail": "linehaul",
            "amount": 946.88
        }
      ],
      "bookUrl": "https://www.freightview.com/app/shipment/570665116d0afce422911667/select-rate/570665116d0afce422911668"
    }
  ],
  "links": {
    "ratesUrl": "https://www.freightview.com/app#quotes/570665116d0afce422911667/rates",
    "spotUrl": "https://www.freightview.com/app#spot-quote/570665116d0afce422911667/carriers"
  }
}
Suggest Edits

Booking within Freightview

 

Once you are retrieving rates back from our rates endpoint, it is easy to complete the booking of the shipment within Freightview. All of this can be done without duplicating data entry in the Freightview system by referencing the shipment id and navigating to a few specific urls.

Book

To select a rate and book the shipment, use the provided url found in the bookUrl property of the rate result. This will take you directly to our booking page to finalize the booking information and schedule a pickup and/or print the BOL.

https://www.freightview.com/app/shipment/:id/select-rate/:rateId

Rate list

To see all available rates and save a quote for complete the booking process, use the provided url found in the links.ratesUrl property of the rate result. This will take you to our rate list page within Freightview.

https://www.freightview.com/app#quotes/:id/rates

Spot quote

To retrieve spot quotes for the shipment, use the provided url found in the links.spotUrl property of the rate result. This will take you to the spot quote page where you can select the equipment types and contacts you want to quote with.

https://www.freightview.com/app#spot-quote/:id/carriers
Suggest Edits

/shipments/:id

Retrieve booked shipment information from Freightview.

 
gethttps://www.freightview.com/api/v1.0/shipments/id
curl -u <api_key>: -H "Content-Type: application/json" -X GET "https://www.freightview.com/api/v1.0/shipments/<shipment_id>"
var request = require("request")

var options = {
  method: "GET",
  url: "https://www.freightview.com/api/v1.0/shipments/<shipment_id>",
  auth: {
    "user": "<api_key>"
  },
  headers: {
    "content-type": "application/json"
  }
}

request(options, function (err, res, body) {
  if (err) throw err
  console.log(body)
})
A binary file was returned

You couldn't be authenticated

{
    "id": "000000000000000000000000",
    "bolNum": "8675309",
    "createdDate": "2018-02-12T17:39:55.240Z",
    "archived": false,
    "direction": "outbound",
    "paymentTerms": "Outbound Prepaid",
    "pickupDate": "2018-02-13T12:00:00.000Z",
    "status": "Pickup scheduled",
    "items": [
        {
            "description": "20 Boxes of equipment",
            "freightClass": 50,
            "hazardous": false,
            "height": 60,
            "length": 48,
            "nmfc": "12345-12",
            "package": "Pallets",
            "pieces": 1,
            "saidToContainPackagingType": "",
            "weight": 500,
            "width": 40
        }
    ],
    "billTo": {
      "company": "Overland Manufacturing",
      "address": "7900 Conser",
      "city": "Overland Park",
      "state": "KS",
      "postalCode": "66204",
      "country": "US",
      "contactName": "Shipping Manager",
      "contactEmail": "shipping@example.com",
      "contactPhone": "(555) 555-5555"
    },
    "accessorials": [
        "residential delivery",
        "arrival schedule"
    ],
    "rate": {
        "carrier": "YRC Freight",
        "carrierId": "52cb030cc3783ba32d000013",
        "carrierCode": "rdwy",
        "guaranteed": false,
        "mode": "LTL",
        "interline": false,
        "quoteNum": "12345678",
        "serviceDescription": "Standard",
        "serviceType": "Standard",
        "total": 116.38,
        "transitDays": 3,
        "createdDate": "2018-02-12T17:39:58.000Z",
        "charges": [
            {
                "name": "discount",
                "amount": -807.22
            },
            {
                "name": "other",
                "amount": 0
            },
            {
                "name": "residential delivery",
                "amount": 5
            },
            {
                "name": "arrival schedule",
                "amount": 0
            },
            {
                "name": "fuel",
                "amount": 21.38
            },
            {
                "name": "linehaul",
                "amount": 897.22
            }
        ]
    },
    "dispatch": {
        "carrier": "YRC Freight",
        "carrierId": "52cb030cc3783ba32d000013",
        "carrierCode": "rdwy",
        "schedulePickup": true,
        "pickupNum": "12345678",
        "proNum": "1234567890"
    },
    "origin": {
        "company": "Overland Manufacturing",
        "address": "7900 Conser",
        "city": "Overland Park",
        "state": "KS",
        "postalCode": "66204",
        "country": "US",
        "contactName": "Shipping Manager",
        "contactEmail": "shipping@example.com",
        "contactPhone": "(555) 555-5555",
        "dockHoursEnd": "4:00 PM",
        "dockHoursStart": "2:00 AM",
        "instructions": "",
        "referenceNumber": "",
        "shipType": "business dock"
    },
    "destination": {
        "company": "My Customer",
        "address": "123 Main St",
        "city": "Boulder",
        "state": "CO",
        "postalCode": "80302",
        "country": "US",
        "contactName": "Customer",
        "contactEmail": "customer@example.com",
        "contactPhone": "(555) 555-5555",
        "dockHoursEnd": "5:00 PM",
        "dockHoursStart": "8:00 AM",
        "instructions": "DELIVERY APPT REQUIRED",
        "referenceNumber": "",
        "shipType": "residential"
    },
    "tracking": {
        "status": "in transit",
        "summary": "En route to terminal",
        "lastUpdatedDate": "2018-02-15T03:32:16.006Z",
        "deliveryDateEstimate": "2018-02-15T00:00:00.000Z",
        "history": [
            {
                "status": "pending",
                "createdDate": "2018-02-13T19:32:40.273Z"
            },
            {
                "status": "in transit",
                "summary": "At origin",
                "createdDate": "2018-02-13T22:31:43.404Z"
            }
        ]
    },
    "invoice": {
      "createdDate": "2018-07-12T18:04:33.723Z",
      "disputedAmount": 0,
      "invoiceAmount": 290.47,
      "invoiceNumber": "4095084",
      "payments": [
        {
          "amount": 290.47,
          "remitted": false
        }
      ]
    },
    "quotedBy": "Salesperson",
    "bookedBy": "Shipping Manager"
}
// empty body - no shipment with matching id

Path Params

id
string
required

The Freightview reference id returned from the rates endpoint.

 
Suggest Edits

Shipment result

A shipment is returned with original quote information as well as charge breakdown, dispatch reference numbers, and tracking data when available.

 

Re-rated shipments

If a shipment gets re-rated we will return the newly re-rated shipment. We will also return a "Location" header in the response with the URL for the re-rated shipment.

The shipment info API only returns booked shipments, if the shipment is not in the correct status the endpoint will return a 404 status code

Property
Type
Description

id

string

A Freightview internal identifier for a specific shipment.

bolNum

string

A Freightview generated BOL number.

createdDate

datetime

This is the date and time the shipment was entered into Freightview.

archived

boolean

Set to true if the shipment has been archived.

direction

string

The direction the shipment is going based on your account locations. (outbound, inbound, third party)

paymentTerms

string

The payment terms used for this shipment.

pickupDate

date

The requested date for pickup of the shipment.

status

string

The current shipment status within Freightview.

items

array

Array of items on the shipment.

items[description]

string

Description of this item.

items[freightClass]

double

Freight class of this item.

items[hazardous]

boolean

Hazardous materials indicator.

items[height]

int

Height of this item in inches.

items[length]

int

Length of this item in inches.

items[width]

int

Width of this item in inches.

items[weight]

int

Total weight of this item in pounds.

items[nmfc]

string

NMFC code for the item.

items[package]

string

Packaging types for this item.

items[pieces]

int

Number of pieces in this item.

items[saidToContainPackageType]

string

Packaging type of the items on this pallet.

billTo

object

The bill to object

billTo.company

string

Company name for the billing party.

billTo.address

string

Address for the billing party.

billTo.city

string

City for the billing party.

billTo.state

string

Two character state abbreviation for the billing party.

billTo.postalCode

string

Five character postal code for the billing party.

billTo.country

string

Two character country code for the billing party.

billTo.contactName

string

Contact name for the billing party.

billTo.contactEmail

string

Email address for the billing party.

billTo.contactPhone

string

Phone number for the billing party.

accessorials

array

Accessorial codes rated on this shipment.

rate

object

Rate object

rate.createdDate

datetime

The date/time this rate was provided.

rate.carrierId

string

A Freightview internal identifier of the asset-based carrier, provider or freight broker that supplied this rate.

rate.carrier

string

The name of the asset-based carrier that will actually move the shipment.

rate.carrierCode

string

The 4-digit SCAC code of the asset-based carrier that will actually move the shipment.

rate.provider

string

The name of the provider or freight broker that supplied this rate.

rate.providerCode

string

The 4-digit SCAC code of the provider or freight broker that supplied this rate.

rate.mode

string

The mode of transit this shipment will use.

rate.interline

boolean

Interline indicator.

rate.quoteNum

string

The quote number provided by the carrier or provider for this rate.

rate.serviceDescription

string

Description of service level for this shipment.

rate.serviceType

string

The type of service for this shipment. (Standard, Guaranteed, etc)

rate.total

double

The total amount of this rate. Includes freight charges, fuel and all additional charges.

rate.transitDays

int

The number of transit days for this shipment.

rate.charges

array

If available, a breakdown of charges for this rate.

rate.charges[name]

string

The name of the charge line item.

rate.charges[amount]

double

The amount of the charge line item.

dispatch

object

A dispatch object

dispatch.carrierId

string

A Freightview internal identifier of the asset-based carrier, provider or freight broker that is handling moving this shipment.

dispatch.carrier

string

The name of the asset-based carrier that will actually move the shipment.

dispatch.carrierCode

string

The 4-digit SCAC code of the asset-based carrier that will actually move the shipment.

dispatch.schedulePickup

boolean

Indicator for if the shipment was scheduled for pickup within Freightview.

dispatch.pickupNum

string

Pickup number provided by the asset-based carrier moving the shipment.

dispatch.proNum

string

Pro number for tracking the shipment.

origin

object

A origin object

origin.company

string

Company name for the pickup location.

origin.address

string

Address for the pickup location.

origin.address2

string

Address line 2 for the pickup location.

origin.city

string

City for the pickup location.

origin.state

string

Two character state abbreviation for the pickup location.

origin.postalCode

string

Five character postal code for the pickup location.

origin.country

string

Two character country code for the pickup location.

origin.contactName

string

Name of a contact person at the pickup location.

origin.contactEmail

string

Email for the contact at the pickup location.

origin.contactPhone

string

Phone number for the contact at the pickup location. (XXX) XXX-XXXX

origin.dockHoursStart

string

Dock opening hour for the pickup location.

origin.dockHoursEnd

string

Dock closing hour for the pickup location.

origin.instructions

string

Special pickup instructions.

origin.referenceNumber

string

Shipper reference number.

origin.shipType

string

Location type for the destination. See the list of valid location types.

destination

object

The destination object

destination.company

string

Company name for the destination location.

destination.address

string

Address for the destination location.

destination.address2

string

Address line 2 for the destination location.

destination.city

string

City for the destination location.

destination.state

string

Two character state abbreviation for the destination location.

destination.postalCode

string

Five character postal code for the destination location.

destination.country

string

Two character country code for the destination location.

destination.contactName

string

Name of a contact person at the destination location.

destination.contactEmail

string

Email for the contact at the destination location.

destination.contactPhone

string

Phone number for the contact at the destination location. (XXX) XXX-XXXX

destination.dockHoursStart

string

Dock opening hour for the destination location.

destination.dockHoursEnd

string

Dock closing hour for the destination location.

destination.instructions

string

Special destination instructions.

destination.referenceNumber

string

Shipper reference number.

destination.shipType

string

Location type for the destination. See the list of valid location types.

tracking

object

Object containing latest tracking info

tracking.status

string

The latest tracking status

tracking.summary

string

The latest tracking summary

tracking.lastUpdatedDate

date

The last time the tracking status changed

tracking.pickupDateActual

date

The actual pickup date of the shipment, if returned

tracking.deliveryDateEstimate

date

The estimated delivery date

tracking.deliveryDateActual

date

The actual delivery date, if returned

tracking.history

array

The entire tracking history

tracking.history[status]

string

Tracking status at this time

tracking.history[summary]

string

Tracking summary at this time

tracking.history[createdDate]

string

Time the tracking update was created

quotedBy

string

The person that quoted this shipment.

bookedBy

string

The person that booked this shipment.

{
    "id": "000000000000000000000000",
    "bolNum": "8675309",
    "createdDate": "2018-02-12T17:39:55.240Z",
    "archived": false,
    "direction": "outbound",
    "paymentTerms": "Outbound Prepaid",
    "pickupDate": "2018-02-13T12:00:00.000Z",
    "status": "Pickup scheduled",
    "items": [
        {
            "description": "20 Boxes of equipment",
            "freightClass": 50, 
            "hazardous": false,
            "height": 60,
            "length": 48,
            "nmfc": "12345-12",
            "package": "Pallets",
            "pieces": 1,
            "saidToContainPackagingType": "",
            "weight": 500,
            "width": 40
        }
    ],
    "billTo": {
      "company": "Overland Manufacturing",
      "address": "7900 Conser",
      "city": "Overland Park",
      "state": "KS",
      "postalCode": "66204",
      "country": "US",
      "contactName": "Shipping Manager",
      "contactEmail": "shipping@example.com",
      "contactPhone": "(555) 555-5555"
		},
    "accessorials": [
        "residential delivery",
        "arrival schedule"
    ],
    "rate": {
        "carrier": "YRC Freight",
        "carrierId": "52cb030cc3783ba32d000013",
        "carrierCode": "rdwy",
        "guaranteed": false,
        "mode": "LTL",
        "interline": false,
        "quoteNum": "12345678",
        "serviceDescription": "Standard",
        "serviceType": "Standard",
        "total": 116.38,
        "transitDays": 3,
        "createdDate": "2018-02-12T17:39:58.000Z",
        "charges": [
            {
                "name": "discount",
                "amount": -807.22
            },
            {
                "name": "other",
                "amount": 0
            },
            {
                "name": "residential delivery",
                "amount": 5
            },
            {
                "name": "arrival schedule",
                "amount": 0
            },
            {
                "name": "fuel",
                "amount": 21.38
            },
            {
                "name": "linehaul",
                "amount": 897.22
            }
        ]
    },
    "dispatch": {
        "carrier": "YRC Freight",
        "carrierId": "52cb030cc3783ba32d000013",
        "carrierCode": "rdwy",
        "schedulePickup": true,
        "pickupNum": "12345678",
        "proNum": "1234567890"
    },
    "origin": {
        "company": "Overland Manufacturing",
        "address": "7900 Conser",
        "city": "Overland Park",
        "state": "KS",
        "postalCode": "66204",
        "country": "US",
        "contactName": "Shipping Manager",
        "contactEmail": "shipping@example.com",
        "contactPhone": "(555) 555-5555",
        "dockHoursEnd": "4:00 PM",
        "dockHoursStart": "2:00 AM",
        "instructions": "",
        "referenceNumber": "",
        "shipType": "business dock"
    },
    "destination": {
        "company": "My Customer",
        "address": "123 Main St",
        "city": "Boulder",
        "state": "CO",
        "postalCode": "80302",
        "country": "US",
        "contactName": "Customer",
        "contactEmail": "customer@example.com",
        "contactPhone": "(555) 555-5555",
        "dockHoursEnd": "5:00 PM",
        "dockHoursStart": "8:00 AM",
        "instructions": "DELIVERY APPT REQUIRED",
        "referenceNumber": "",
        "shipType": "residential"
    },
    "tracking": {
        "status": "in transit",
        "summary": "En route to terminal",
        "lastUpdatedDate": "2018-02-15T03:32:16.006Z",
        "deliveryDateEstimate": "2018-02-15T00:00:00.000Z",
        "history": [
            {
                "status": "pending",
                "createdDate": "2018-02-13T19:32:40.273Z"
            },
            {
                "status": "in transit",
                "summary": "At origin",
                "createdDate": "2018-02-13T22:31:43.404Z"
            }
        ]
    },
    "quotedBy": "Salesperson",
    "bookedBy": "Shipping Manager"
}
Suggest Edits

Shipment search result

A list of shipments matching the search criteria is returned.

 
Property
Type
Description

shipments

array

An array of shipments.

links.previous

string

API url to get the previous page of results.

links.next

string

API url to get the next page of results.

total

int

Total number of shipments found.

page

int

Current page of results returned.

Suggest Edits

Response Codes

 

Freightview returns standard HTTP codes within the response to every API request. If the request results in an error, the response will also include an error object with additional information.

{
  'error': 'invalid_request',
  'message' : 'Shipment origin must be specified.'
}
Code
Status
Description

200

OK

The request processed succesfully.

400

Bad Request

The request was missing a parameter.

401

Unauthorized

Authentication failed on the request.

402

Payment Required

No active subscription with Freightview.

404

Not Found

The API endpoint does not exist.

500

Server Error

There's a problem on Freightview's side.

Suggest Edits

Location types

 

Use these location types in the originType and destType fields to insure accurate rating.

  • business dock
  • business no dock
  • residential
  • limited access
  • trade show
  • construction
  • farm

Liftgates

Liftgate charges will not be added automatically. If you need a liftgate at the pickup or delivery, just put liftgate pickup or liftgate delivery in the charges array in the rate request.

Suggest Edits

Freight classes

 

Freightview supports the following standard freight classes.

  • 50
  • 55
  • 60
  • 65
  • 70
  • 77.5
  • 85
  • 92.5
  • 100
  • 110
  • 125
  • 150
  • 175
  • 200
  • 250
  • 300
  • 400
  • 500
Suggest Edits

Accessorials

 

List these strings in the charges array of the request.

  • arrival notice
  • arrival schedule
  • liftgate pickup
  • liftgate delivery
  • inside pickup
  • inside delivery
  • sort and segregate

Facility type charges

Location based charges (residential delivery, tradeshow delivery, etc) will be automatically added based on the location type used.

Suggest Edits

Packaging types

 
  • Pallets_48x40
  • Pallets_48x48
  • Pallets_60x48
  • Pallets_other
  • Bags
  • Bales
  • Boxes
  • Bundles
  • Carpets
  • Cases
  • Coils
  • Crates
  • Cylinders
  • Drums
  • Pails
  • Reels
  • Rolls
  • TubesPipes
  • Slipsheets
  • Unit

Pallet dimensions

Pallet packaging types with dimensions (Pallets_48x40, etc) will automatically set the dimensions of the item. To specify pallets with a custom dimension, use Pallets_other and set the length, width, and height of the item.

Dimensions

Item dimensions are optional, however many freight brokers and carriers do not provide their best LTL rates without dimensions. For the best rates, enter dimensions.

Suggest Edits

Payment Terms

 
  • Outbound Prepaid
  • Outbound Collect
  • Inbound Collect
  • Third Party Prepaid
  • Third Party Collect
Suggest Edits

Carrier codes

 
Name
SCAC

A. Duie Pyle

pyle

AAA Cooper Transportation

aact

ABF Freight System

abfs

Access America Transport

aatj

Averitt Express

avrt

Beaver Express Service

beav

Benton Global

btnb

Best Overnite Express

btvp

Blue-Grace Logistics

bglf

Bolt Express

bxpe

B&H Freight

bahf

Central Freight Lines

cenf

Central Transport

ctii

CH Robinson

rblt

Clear Lane Freight Systems

clni

Con-way Freight

cnwy

Coyote Logistics

cllq

The Custom Companies

ctbv

Daylight Transport

dylt

Dayton Freight Lines

dafg

Dependable Highway Express

dphe

Dohrn Transfer Company

dhrn

DotLine Transportation

dolr

Dugan Truck Line

dubl

Echo Global Logistics

echo

EDI Express

edxi

Estes Express Lines

exla

FedEx Freight

fxfe

Flo Trans

flan

Forward Air

fwdn

Freightcenter

frcd

Freightquote

frci

Frontline Freight

fcsy

GlobalTranz

gelj

USF Holland

hmes

HomeDirect

bkhd

Land Air Express of New England

laxv

Lakeville Motor Express

lkvl

Midwest Motor Express

midw

Nebraska Transport

nebt

New Century Transportation

ncta

New England Motor Freight

nemf

New Penn Motor Express

npme

Oak Harbor Freight Lines

oakh

Old Dominion Freight Line

odfl

Panama Transfer

pana

Panther Premium Logistics

ptwt

Pilot Freight Services

paaf

Pitt Ohio

pitd

R+L Carriers

rlca

RJW Transport

rjwi

Reddaway

retl

Roadrunner Transportation Services

rdfs

Saia Motor Freight Line

saia

Southeastern Freight Lines

sefl

Southwestern Motor Transport

smtl

Standard Forwarding

stdf

Sunset Pacific Transportation

sfpa

Total Quality Logistics

tqyl

Towne Air Freight

towe

Unishippers

ulrd

United Van Lines

uvln

UPS Freight

upgf

Ward Transport

ward

Xpress Global Systems

xgsi

U.S. Road

usrd

YRC Freight

rdwy