Forward Expedited LTL Web Services

API Services Home

Forward Air Status Retrieval Web Services

Webservice to get statuses of shipments.

Service URL

Name Service URL Additional details
Rest ${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/statuses Example test url: https://test-api.forwardair.com/ltlservices/v2/rest/waybills/12345678/statuses
Rest (current status only) ${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/statuses/currentStatus Example test url: https://test-api.forwardair.com/ltlservices/v2/rest/waybills/12345678/statuses/currentStatus
Soap ${baseUrl}/ltlservices/v2/StatusService Example test url: https://test-api.forwardair.com/ltlservices/v2/StatusService
WSDL for Status Service: Status WSDL

Rest Service statuses

Request Parameters
Name Type Required Description
user Header param Y Your API username. Please note this is not the same as your web username.
password Header param Y Your API password. Please note this is not the same as your web password.
billToAccountNumber Header param Y This is the full 7 digit bill to account number associated to the airbill and your user/password credentials.
referenceNumber String Y This will be the 8 digit airbill number or the full gabs key (origin gateway, airline code, airbill, sequence). If providing the full gabs key, use dashes in the individual parts. Ex. DFW-472-12345678-00

Response

The response for statuses returns an array of statuses

Name Type Description
statusCode String Status Code (see below for codes and descriptions)
statusDescription String Status Code description (see below for codes and descriptions)
recordedBy String Status recorded by name.
recordDate String Format is MM/DD/YY 24HH:mm. Example: 11/11/10 17:00
timeZoneCode String (PT, MT, CT, ET)
airportCode String 3 char code for airport.
pieces Number Handled pieces
chargeableWeight Number Chargeable weight for this shipment.
weightType String L for Lbs and K for Kgs.
dimWeight Number (this can be 0.0 if no dim performed)
dimFlag String 0 for N or 1 for Y
reweighFlag String 0 for N or 1 for Y
estimatedArrivalDate String Format MM/DD/YY 24HH:mm. This will be the latest estimate of arrival.
scheduledDeliveryFromDate String Format MM/DD/YY 24HH:mm. This can be blank unless there is a delivery service.
scheduledDeliveryToDate String Format MM/DD/YY 24HH:mm. This can be blank unless there is a delivery service.
moveReferenceNumber String This is the manifest number for the move (if applicable).
city String City
state String State
zip String Zip
country String Country
lat String Lattitude
lon String Longitude

Rest Service response sample

Response json
[{
        "statusCode": "DPUP",
        "statusDescription": "Dispatched for Pickup",
        "recordedBy": "Driver",
        "recordDate": "11/06/20 11:02",
        "timeZoneCode": "CT",
        "airportCode": "ORD",
        "moveReferenceNumber": null,
        "moveReferenceNumberType": null,
        "pieces": 2,
        "chargeableWeight": 363.0,
        "weightType": "L",
        "dimWeight": 324.0,
        "dimFlag": "1",
        "reweighFlag": "0",
        "estimatedArrivalDate": "11/09/20 08:00",
        "scheduledDeliveryFromDate": "11/09/20 08:00",
        "scheduledDeliveryToDate": "11/09/20 17:00",
        "city": "DES PLAINES",
        "state": "IL",
        "zip": "60018",
        "country": "US",
        "lat": "42.019902",
        "lon": "-87.92752"
    },
    {
        "statusCode": "PUP",
        "statusDescription": "Pickup",
        "recordedBy": "Driver",
        "recordDate": "11/06/20 14:42",
        "timeZoneCode": "CT",
        "airportCode": "ORD",
        "moveReferenceNumber": null,
        "moveReferenceNumberType": null,
        "pieces": 2,
        "chargeableWeight": 363.0,
        "weightType": "L",
        "dimWeight": 324.0,
        "dimFlag": "1",
        "reweighFlag": "0",
        "estimatedArrivalDate": "11/09/20 08:00",
        "scheduledDeliveryFromDate": "11/09/20 08:00",
        "scheduledDeliveryToDate": "11/09/20 17:00",
        "city": "DES PLAINES",
        "state": "IL",
        "zip": "60018",
        "country": "US",
        "lat": "42.019902",
        "lon": "-87.92752"
    }
]

Back to Top

Soap Service getCurrentStatus

Request Parameters
Name Type Required Description
user Header param Y Your API username. Please note this is not the same as your web username.
password Header param Y Your API password. Please note this is not the same as your web password.
referenceNumber String Y This will be the 8 digit airbill number or the full gabs key (origin gateway, airline code, airbill, sequence). If providing the full gabs key, use dashes in the individual parts. Ex. DFW-472-12345678-00
billToAccountNumber String Y This is the full 7 digit bill to account number associated to the airbill and your user/password credentials.

Response

The response for getCurrentStatus returns a WaybillStatus object

Name Type Description
statusCode String Status Code (see below for codes and descriptions)
statusDescription String Status Code description (see below for codes and descriptions)
recordedBy String Status recorded by name.
recordDate String Format is MM/DD/YY 24HH:mm. Example: 11/11/10 17:00
timeZoneCode String (PT, MT, CT, ET)
airportCode String 3 char code for airport.
pieces Number Handled pieces
chargeableWeight Number Chargeable weight for this shipment.
weightType String L for Lbs and K for Kgs.
dimWeight Number (this can be 0.0 if no dim performed)
dimFlag String 0 for N or 1 for Y
reweighFlag String 0 for N or 1 for Y
estimatedArrivalDate String Format MM/DD/YY 24HH:mm. This will be the latest estimate of arrival.
scheduledDeliveryFromDate String Format MM/DD/YY 24HH:mm. This can be blank unless there is a delivery service.
scheduledDeliveryToDate String Format MM/DD/YY 24HH:mm. This can be blank unless there is a delivery service.
moveReferenceNumber String This is the manifest number for the move.
moveReferenceNumberType String MANIFEST


Request Samples
Soap XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.shipmentbooking.forwardair.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:getCurrentStatus>
         <user>YOUR USER ID</user>
         <password>YOUR PASSWORD</password>
         <referenceNumber>YOUR REF NUMBER</referenceNumber>
         <billToAccountNumber>YOUR BILLING ACCOUNT</billToAccountNumber>
      </web:getCurrentStatus>
   </soapenv:Body>
</soapenv:Envelope>

Response Samples
Response XML
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getCurrentStatusResponse xmlns:ns2="http://webservices.shipmentbooking.forwardair.com/">
         <return>
            <statusCode>INVC</statusCode>
            <statusDescription>Invoiced</statusDescription>
            <recordedBy>FORWARD AIR</recordedBy>
            <recordDate>10/23/20 09:34</recordDate>
            <timeZoneCode>ET</timeZoneCode>
            <airportCode>GCY</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
            <moveReferenceNumber>2786607</moveReferenceNumber>
            <moveReferenceNumberType>INVOICE</moveReferenceNumberType>
         </return>
      </ns2:getCurrentStatusResponse>
   </soap:Body>
</soap:Envelope>

Back to Top

Soap Service getStatusHistory

Parameters are same as getCurrentStatus
Soap XML
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservices.shipmentbooking.forwardair.com/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:getStatusHistory>
         <user>YOUR USER ID</user>
         <password>YOUR PASSWORD</password>
         <referenceNumber>YOUR REF NUMBER</referenceNumber>
         <billToAccountNumber>YOUR BILLING ACCOUNT</billToAccountNumber>
      </web:getStatusHistory>
   </soapenv:Body>
</soapenv:Envelope>

Response Samples
Response XML
		
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <ns2:getStatusHistoryResponse xmlns:ns2="http://webservices.shipmentbooking.forwardair.com/">
         <return>
            <statusCode>PUP</statusCode>
            <statusDescription>Pickup</statusDescription>
            <recordedBy>Driver</recordedBy>
            <recordDate>10/20/20 08:40</recordDate>
            <timeZoneCode>CT</timeZoneCode>
            <airportCode>ORD</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
         </return>
         <return>
            <statusCode>TND</statusCode>
            <statusDescription>Tendered</statusDescription>
            <recordedBy>SANCHEZ</recordedBy>
            <recordDate>10/20/20 18:12</recordDate>
            <timeZoneCode>CT</timeZoneCode>
            <airportCode>ORD</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
         </return>
         <return>
            <statusCode>DEP</statusCode>
            <statusDescription>Departed</statusDescription>
            <recordedBy>BIEHL</recordedBy>
            <recordDate>10/20/20 20:06</recordDate>
            <timeZoneCode>CT</timeZoneCode>
            <airportCode>ORD</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
            <moveReferenceNumber>001242193</moveReferenceNumber>
            <moveReferenceNumberType>MANIFEST</moveReferenceNumberType>
         </return>
         <return>
            <statusCode>ARR</statusCode>
            <statusDescription>Arrived</statusDescription>
            <recordedBy>HUSK</recordedBy>
            <recordDate>10/21/20 02:09</recordDate>
            <timeZoneCode>ET</timeZoneCode>
            <airportCode>IND</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
            <moveReferenceNumber>001242193</moveReferenceNumber>
            <moveReferenceNumberType>MANIFEST</moveReferenceNumberType>
         </return>
         <return>
            <statusCode>DEP</statusCode>
            <statusDescription>Departed</statusDescription>
            <recordedBy>TRUMP</recordedBy>
            <recordDate>10/21/20 04:45</recordDate>
            <timeZoneCode>ET</timeZoneCode>
            <airportCode>IND</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
            <moveReferenceNumber>001243360</moveReferenceNumber>
            <moveReferenceNumberType>MANIFEST</moveReferenceNumberType>
         </return>
         <return>
            <statusCode>ARRD</statusCode>
            <statusDescription>Arrived at Dest</statusDescription>
            <recordedBy>SIMMONS</recordedBy>
            <recordDate>10/21/20 07:22</recordDate>
            <timeZoneCode>CT</timeZoneCode>
            <airportCode>EVV</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
            <moveReferenceNumber>001243360</moveReferenceNumber>
            <moveReferenceNumberType>MANIFEST</moveReferenceNumberType>
         </return>
         <return>
            <statusCode>DPUP</statusCode>
            <statusDescription>Dispatched for Pickup</statusDescription>
            <recordedBy>Driver</recordedBy>
            <recordDate>10/21/20 08:39</recordDate>
            <timeZoneCode>CT</timeZoneCode>
            <airportCode>ORD</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
         </return>
         <return>
            <statusCode>TAGNT</statusCode>
            <statusDescription>Recovered from FA</statusDescription>
            <recordedBy>SIMMONS</recordedBy>
            <recordDate>10/21/20 09:15</recordDate>
            <timeZoneCode>CT</timeZoneCode>
            <airportCode>EVV</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
         </return>
         <return>
            <statusCode>OUTDV</statusCode>
            <statusDescription>Out for delivery</statusDescription>
            <recordedBy>Driver</recordedBy>
            <recordDate>10/21/20 11:12</recordDate>
            <timeZoneCode>CT</timeZoneCode>
            <airportCode>EVV</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
         </return>
         <return>
            <statusCode>DLV</statusCode>
            <statusDescription>Delivered</statusDescription>
            <recordedBy>bell</recordedBy>
            <recordDate>10/21/20 16:06</recordDate>
            <timeZoneCode>CT</timeZoneCode>
            <airportCode>EVV</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
         </return>
         <return>
            <statusCode>INVC</statusCode>
            <statusDescription>Invoiced</statusDescription>
            <recordedBy>FORWARD AIR</recordedBy>
            <recordDate>10/23/20 09:34</recordDate>
            <timeZoneCode>ET</timeZoneCode>
            <airportCode>GCY</airportCode>
            <pieces>3</pieces>
            <chargeableWeight>219.0</chargeableWeight>
            <weightType>L</weightType>
            <dimWeight>0.0</dimWeight>
            <dimFlag>0</dimFlag>
            <reweighFlag>0</reweighFlag>
            <estimatedArrivalDate>10/21/20 09:00</estimatedArrivalDate>
            <scheduledDeliveryFromDate>10/21/20 08:00</scheduledDeliveryFromDate>
            <scheduledDeliveryToDate>10/21/20 17:00</scheduledDeliveryToDate>
            <moveReferenceNumber>2786607</moveReferenceNumber>
            <moveReferenceNumberType>INVOICE</moveReferenceNumberType>
         </return>
      </ns2:getStatusHistoryResponse>
   </soap:Body>
</soap:Envelope>

Back to Top


Status Codes

Status Description
ACK Acknowledged (This gets created on a linehaul without pickup when airbill is live)
RCV Received (Generally same as above, but can also mean the freight was tendered in some locations)
TND Tendered (Freight has been tendered)
PUPACK Pickup Acknowledged (only on shipments with pickup service)
DPUP Dispatched for Pickup
PUP Pickup
DEP Departed (origin or transfer terminal)
ARR Arrived (at transfer terminal)
ARRD Arrived at Dest
TAGNT Recovered from FA (This one is being phased out)
OUTDV Out for Delivery
ARRD Arrived at Dest
DLV Delivered
COMP Recovered (linehaul, consignee recovered from dock).
INVC Invoiced
DELAY Shipment delayed
DARR Arrived at delivery location
PARR Arrived at pickup location
PPL Pickup Planned
DPL Delivery planned
ST Storage Fee Notification
OP Order Planned
UNC Uncancelled
LOAD Loaded
WC Weight changed

Back to Top

Last updated 01/07/2021