BOL
| API | Description |
|---|---|
| GET api/FetchBOL?User={User}&Pass={Pass}&SearchFor={SearchFor}&SearchType={SearchType} |
Use this API function to retrieve a PDF rendition of the Billing of Lading document on fle for the requested Pro. |
InvoicePDF
| API | Description |
|---|---|
| GET api/FetchInvPDF?User={User}&Pass={Pass}&DocNumber={DocNumber} |
Use this API function to retrieve a PDF rendition of the requested invoice. |
ShipmentStatus
| API | Description |
|---|---|
| GET api/GetShipmentStatus?User={User}&Pass={Pass}&SearchFor={SearchFor}&SearchType={SearchType} |
Use this API function to retrieve the recorded shipment status(es) for the targeted Shipment |
POD
| API | Description |
|---|---|
| GET api/FetchPOD?User={User}&Pass={Pass}&SearchFor={SearchFor}&SearchType={SearchType} |
Use this API function to retrieve a PDF rendition of the Proof of Delivery document for the requested Pro. |
TransitTime
| API | Description |
|---|---|
| GET api/TransitTime?User={User}&Pass={Pass}&OriginZip={OriginZip}&DestinationZip={DestinationZip}&PickupDate={PickupDate} |
This API is used to calculate the number of business days that it will take to move a shipment from its origin point to its destination. When a pickup date is provided, the results returned will also include the date on which an on-time delivery would take place. |
Tracing
| API | Description |
|---|---|
| GET api/TraceByPro?User={User}&Pass={Pass}&Pronum={Pronum} |
This API will search for a single shipment by its assigned Pro Number and return dispatch activity associated with the shipment. |
| GET api/TraceByBOL?User={User}&Pass={Pass}&BOL={BOL} |
This API will search for a single shipment by its Bill of Lading number (BOL#) and return dispatch activity associated with the shipment. |
| GET api/TraceByPO?User={User}&Pass={Pass}&PONumber={PONumber} |
This API will search for a single shipment by Purchase Order number (PO#) and return dispatch activity associated with the shipment. |
| GET api/TraceBySID?User={User}&Pass={Pass}&SID={SID} |
This API will search for a single shipment by its assigned shipment id# (SID#) and return dispatch activity associated with the shipment. |
| GET api/TraceByCarrierPro?User={User}&Pass={Pass}&CarrierPro={CarrierPro} |
This API will search for a single shipment by a partner carrier's pro number (CarrierPro#) and return dispatch activity associated with the shipment. |
InvoiceListByPro
| API | Description |
|---|---|
| GET api/InvoiceListByPro?User={User}&Pass={Pass}&ProNumber={ProNumber} |
Use this function to retrieve the invoice reference associated with a specific pro number. |
ARStatement
| API | Description |
|---|---|
| GET api/ARStatement?User={User}&Pass={Pass} |
Use this function to retrieve a Statement of Account for all open Accounts Receivable Items |
Invoice
| API | Description |
|---|---|
| GET api/Invoice?User={User}&Pass={Pass}&InvoiceNumber={InvoiceNumber} |
Use this function to retrieve the data associated with a specific invoice. A seperate API has also been made available for retrieving an image rendition of the invoice. |
QuoteRequest
| API | Description |
|---|---|
| POST api/QuoteRequest |
Use this function to obtain a rate quotation for a shipment. Submit your HttpRequestMessage in either XML or JSON format with content mapped as per the _RequestSubmitted/QuoteRequest structure defined in the Response Information documentation. |
AccountLookup
| API | Description |
|---|---|
| POST api/AccountLookup |
Use this function to search for accounts based on criteria supplied in your request. Any combination of non-blank fields within the AccountLookupRequest structure will query for matching records. A maximum of 20 records will be returned as results from this lookup, and if the request produces more than 20 records, no records will be returned and you will be prompted to refine your search parameters to bring that count down to 20 or fewer. |
PickupRequest
| API | Description |
|---|---|
| POST api/PickupRequest |
Use this function to submit a Pickup Request for a shipment via the POST of an HttpRequestMessage where the PickupRequest structure may be submitted in either XML or JSON format. |
RateRequest
| API | Description |
|---|---|
| POST api/RateRequest |
Use this function to price a shipment. Submit your HttpRequestMessage in either XML or JSON format with content mapped as per the _RequestSubmitted/RateRequest structure defined in the Response Information documentation. |
AccessorialList
| API | Description |
|---|---|
| GET api/AccessorialList?User={User}&Pass={Pass} |
Use this function to retrieve a list of valid Accessorial Service codes and their associated descriptions. |