Forward Expedited LTL Web Services : Documents

Forward Air Documents Web Services

Webservice to upload or download documents.

Service URL

Name	Service URL	Additional details
List Documents	${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/documents	Example test url: https://test-api.forwardair.com/ltlservices/v2/rest/waybills/12345678/documents
Download Document	${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/documents/download?docId={{docId from previous call}}	Example test url: https://test-api.forwardair.com/ltlservices/v2/rest/waybills/12345678/documents?docId={{alongdockidstringfrompreviouscall}} You can use document shortcuts below.
Download Document	${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/documents/{documentType}	Example POD test url: https://test-api.forwardair.com/ltlservices/v2/rest/waybills/12345678/documents/POD Example BOL test url: https://test-api.forwardair.com/ltlservices/v2/rest/waybills/12345678/documents/BOL You can use document shortcuts below.
Upload Document	Post to ${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/documents?documentType={{documentType}}	Example test url: https://test-api.forwardair.com/ltlservices/v2/rest/waybills/12345678/documents?documentType=OTHER
Upload Document Types	Get to ${baseUrl}/ltlservices/v2/rest/documenttypes	Example test url: https://test-api.forwardair.com/ltlservices/v2/rest/documenttypes

Rest Service Documents

Request Parameters. GET ${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/documents

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 returns an array of documents on this shipment

Name	Type	Description
documentType	String	Document type. Supported types are below.
fileName	String	File name
fileType	String	File type
waybillGabsKey	String	Unique key for this shipment
fileSize	int	File size
link	String	Link to download the document binary file.
gabsKey	String	Same as waybillGabsKey.

Rest Service response sample

Response json

[
    {
        "documentType": "Other Support Document",
        "fileName": "DMALP0618120BOL.pdf",
        "fileType": "pdf",
        "waybillGabsKey": "ORD-472-74612199-00",
        "fileSize": 0,
        "link": "https://test-api.forwardair.com/ltlservices/v2/rest/waybills/74612199/documents/download?docId=RqUag4H77i3Re17%2B2SKoFEuCeeY1oRQnpELcQt6rk1%2BcdXTONfGm8MLWTiWh%2Bd2eOiaUptpruqarDCwnTfbv91zJzWz5BmSozm5uHVwcgO4BgZD8YzbPmCPPinWRNmFUbjsKt0RWyi5tajY8GM2SmNL94W6woAai6FDEo9bdrNg%3D",
        "gabsKey": "ORD-472-74612199-00"
    },
    {
        "documentType": "Other Support Document",
        "fileName": "DMALP0618120DO.pdf",
        "fileType": "pdf",
        "waybillGabsKey": "ORD-472-74612199-00",
        "fileSize": 0,
        "link": "https://test-api.forwardair.com/ltlservices/v2/rest/waybills/74612199/documents/download?docId=RqUag4H77i3Re17%2B2SKoFEuCeeY1oRQnpELcQt6rk1%2BcdXTONfGm8MLWTiWh%2Bd2eOiaUptpruqarDCwnTfbv91zJzWz5BmSoE9jgHekb7T4uLYxKPCi3kAvjkf7bEmeyukKDm4qBwaUUkhUElCrPwyQqLaSiTFqOIo0zU9gf9b4IO0NNCXtkVQ%3D%3D",
        "gabsKey": "ORD-472-74612199-00"
    }
]

Rest Service Document Download

Request Parameters. GET ${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/documents/download?docId={{docId}}

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
docId	String	Y	This will be the docId from the previous call. You can just take the link from the previous call and call it with the credentials headers for ease.

Response

The response returns binary document data.

Name	Type	Description
body	Binary Data	Binary Data. Review header for file name and disposition details.

Error Response

The response returns for error case. Http error code will be other than 2XX

Name	Type	Response Code	Description
body	Json data if Airbill is not found	400	{ "errorMessage": "No waybills found for this reference number." }

Rest Service Document Download

Request Parameters. GET ${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/documents/{documentType}

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
documentType	String	Y	This will be the documentType (ex: POD or BOL or SHIPBOLIMG or any other document type).

Response

The response returns binary document data.

Name	Type	Description
body	Binary Data	Binary Data. Review header for file name and disposition details.

Error Response

The response returns for error case. Http error code will be other than 2XX

Name	Type	Response Code	Description
body	Json data if Airbill is not found	400	{ "errorMessage": "No waybills found for this reference number." }

Rest Service Document Upload

Request Parameters. POST ${baseUrl}/ltlservices/v2/rest/waybills/{{referenceNumber}}/documents?documentType={{documentType}}

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
documentType	String	Y	This will be the allowed upload document type. List of allowed types can be retried from the api call below.

Response

Response json

{
"message": "OK"
}

Rest Service Upload Document Types

Request Parameters GET ${baseUrl}/ltlservices/v2/rest/documenttypes

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.

Response

Response json

{ 
	"documenttype": [ 
		"CANADA","DELIVER","GSA","HAZMAT","INBOND","OTHER","PICKUP","SHIPBOL"
	] 
}

Document Types

Document Type	Description
CANADA	Canada Documents
DELIVER	Delivery Documents
GSA	GSA Documents
HAZMAT	Hazmat Shipments Documents
INBOND	Inbond Shipment Related Documents
OTHER	Other Supported Documents
PICKUP	Pickup Documents
SHIPBOLIMG	Shipper Bol. Available only if shipper bol was uploaded into the shipment.