URL Format Representational State Transfer (REST) Web Service
Version
V3X2 (Major Version 3, Minor Version 2)
Description
Track Detail Web Service returns detailed tracking information for the shipment identified by your PRO, PO or BOL number.
URL format (REST/URLweb service)
https://api.reddawayregional.com/api/TrackShipments/doTrackDetail?accessKey=&searchBy=PRO&number=
Request structure
| Parameter | Value | Description |
| accessKey | String (required) | Access Key identifying the user invoking the service. |
| searchBy | String (required) | Search by can be PRO, PO or BOL. |
| number | String (required) | Number identifying the shipment. |
| postalCode | String (required if searchBy is PO or BOL) | Postal Code associated with the shipment. |
Response structure
| Parameter | Value | Description |
| STATUS:CODE | Integer | Status code of the response. Valid values are: 0: Success1: Error |
| STATUS:ERROR_TYPE | String | Error type returned if applicable. Valid values are: AUTHENTICATION_ERROR: Invalid reddawayregional.com credentials were supplied INPUT_ERROR: Error in input parameters PROCESSING_ERROR: Internal processing error. Please retry or contact reddawayregional.com Support NOT_FOUND_ERROR: Requested information not found NOT_ALL_FOUND_ERROR: Some requested information not found |
| STATUS:VIEW | String | Response View. Valid values are: PUBLIC: Unsecured view. Returned when service is invoked with no credentials or when business rules prevent access to secured information. SECURED: Secured View. Complete information including secured data. ERROR: Error View. |
| STATUS:MESSAGE | String | Error message (if applicable) |
| STATUS:VERSION:CURRENT | String | Version of service. Format is V[Major version number]X[Minor version number] |
| STATUS:VERSION:CURRENT_RELEASE_DATE | Date | Release date of service. Format is MM/DD/YYYY |
| STATUS:VERSION:LATEST | String | Latest available version of this service. Format is V[Major version number]X[Minor version number] |
| STATUS:VERSION:LATEST_RELEASE_DATE | Date | Release date of latest available service. Format is MM/DD/YYYY |
| PRONUMBER | String | PRO Number |
| PONUMBER | String | PO Number |
| BOLNUMBER | String | BOL Number |
| CURRENTSTATUS | String | Current Status |
| CURRENTSTATUSDATE | Date | Current Status Date (MM/DD/YYYY) |
| PICKUPDATE | Date | Pickup Date (MM/DD/YYYY) |
| STANDARDDELIVERYDATE | Date | Standard Delivery Date (MM/DD/YYYY) |
| SHIPPER:NAME | String | Shipper Name |
| SHIPPER:ADDRESS1 | String | Shipper Address Line 1 |
| SHIPPER:ADDRESS2 | String | Shipper Address Line 2 |
| SHIPPER:ADDRESS3 | String | Shipper Address Line 3 |
| CONSIGNEE:NAME | String | Consignee Name |
| CONSIGNEE:ADDRESS1 | String | Consignee Address Line 1 |
| CONSIGNEE:ADDRESS2 | String | Consignee Address Line 2 |
| CONSIGNEE:ADDRESS3 | String | Consignee Address Line 3 |
| THIRDPARTY:NAME | String | Third-Party Name |
| THIRDPARTY:ADDRESS1 | String | Third-Party Address Line 1 |
| THIRDPARTY:ADDRESS2 | String | Third-Party Address Line 2 |
| THIRDPARTY:ADDRESS3 | String | Third-Party Address Line 3 |
| ORIGIN:NAME | String | Origin Service Center Name |
| ORIGIN:CARRIER | String | Origin Service Center Company |
| ORIGIN:ADDRESS | String | Origin Service Center Address |
| ORIGIN:CITY | String | Origin Service Center City |
| ORIGIN:STATE | String | Origin Service Center State |
| ORIGIN:ZIP | String | Origin Service Center ZIP |
| ORIGIN:PHONE | String | Origin Service Center Contact Phone |
| ORIGIN:PHONE_TOLLFREE | String | Origin Service Center Toll-Free Phone |
| ORIGIN:FAX | String | Origin Service Center Fax Number |
| DESTINATION:NAME | String | Destination Service Center Name |
| DESTINATION:CARRIER | String | Destination Service Center Carrier Company |
| DESTINATION:ADDRESS | String | Destination Service Center Address |
| DESTINATION:CITY | String | Destination Service Center City |
| DESTINATION:STATE | String | Destination Service Center State |
| DESTINATION:ZIP | String | Destination Service Center ZIP |
| DESTINATION:PHONE | String | Destination Service Center Contact Phone |
| DESTINATION:PHONE_TOLLFREE | String | Destination Service Center Toll-Free Phone |
| DESTINATION:FAX | String | Destination Service Center Fax Number |
| SERVICETYPE | String | Service type. Valid values are: INTERLINE: Interline serviceGUARANTEED_NOON: Guaranteed by noonGUARANTEED_9AM: Guaranteed by 9 a.m.GUARANTEED_330PM: Guaranteed by 3:30 p.m.REGIONAL_DELIVERY: Regional Delivery serviceINTERREGIONAL_DELIVERY: Inter-Regional Delivery serviceEXPEDITED_DELIVERY: Expedited serviceEXPEDITED_DELIVERY_5PM: Expedited service delivery by 5 p.m.EXPEDITED_DELIVERY_12PM: Expedited service delivery by noon |
| TOTAL CHARGES | String | Total Charges, including currency symbol |
| SHIPMENT_ITEM[1..n] | Multiple | Shipment line item rows |
| SHIPMENT_ITEM:PIECES | String | Line item pieces |
| SHIPMENT_ITEM:DESCRIPTION | String | Line item description |
| SHIPMENT_ITEM:CLASS | String | Line item class |
| SHIPMENT_ITEM:WEIGHT | String | Line item weight |
| SHIPMENT_ITEM:RATE | String | Line item rate |
| SHIPMENT_ITEM:CHARGESASSTRING | String | Line item charges |
| SIGNATURE | String | Signer |
| SERVICEEXCEPTIONS | String | Service exceptions if any |
| APPOINTMENT:NAME | String | Appointment for |
| APPOINTMENT:DATE | Date | Appointment Date (MM/DD/YYYY) |
| APPOINTMENT:TIME | String | Appointment time in 24 HRS CST |
| NOTIFICATION | String | Notification if any |
| DISCLAIMER | String | Disclaimer |
| TERMS | String | Payment terms. Valid values are: PREPAID: Pre-paidCOLLECT: Collect3RDPARTY: 3rd Party |