API docs by Redocly

In Transit Visibility API (1.2)

Download OpenAPI specification:Download

NMFTA Digital LTL Council: support@nmfta.org License: NMFTA License

The In Transit Visibility API provides insight into a shipment's movement as it navigates through the pickup and delivery process. Once the carrier has picked up the shipment, shippers will be able to understand where the shipment is in transit between pickup and delivery.

This In Transit Visibility API will include all status updates along the path of the shipment and starts when the carrier acknowledges they have a shipment and ends when the carrier delivers the shipment to the receiver and the receiver acknowledges receipt.

This YAML is intended to provide guidance and is not executable code. Implementers are encouraged to use provided structure and data elements where possible, however, implementation decisions including endpoint structure and available data are at the implementers discretion.

The API structure includes elements that may not be applicable to all implementation. For instance, the security section contains both bearerAuth and apiKeyAuth, however, implementers may choose to use one or both.

Verified Shipment Status Queries

Get shipment information with an identifying number by a verified account.

Shipment information by Pro Number

Results for a single shipment that is an exact match.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
proNumber
required
string
Example: 123456789

The carrier assigned Pro Number associated with the shipment.

Responses

Response samples

Content type
application/json
{
  • "ProNumber": "string",
  • "ReferenceNumbers": null,
  • "UniqueID": "string",
  • "UpdatedPro": "string",
  • "PayType": "string",
  • "ShipType": "string",
  • "PickupAddress": null,
  • "BillToAddress": null,
  • "BillToAccountNumber": "string",
  • "ConsigneeAddress": null,
  • "DESaccessorial": [
    ],
  • "DESLimitedAccess": null,
  • "TimeCriticalType": null,
  • "TimeCriticalInfo": null,
  • "GrossWeight": 0,
  • "Commodities": null,
  • "HandlingUnits": null,
  • "ShipmentLocation": null,
  • "ShipmentMilestoneStatus": "Picked-up",
  • "ShipmentMilestoneStatusLong": "string",
  • "ShipmentTerminalInfo": null,
  • "TimeZoneOfShipment": "string",
  • "UpdatedETA": "2019-08-24T14:15:22Z",
  • "EstimatedStandardDay": 0,
  • "EstimatedDeliveryDate": "2019-08-24T14:15:22Z",
  • "OFDStopsAway": 0,
  • "Reconsignment": false,
  • "ShipmentShortage": false,
  • "ShipmentDamage": false,
  • "AllShortOrLostShipment": false,
  • "Late": false,
  • "DelayReasonCode": null,
  • "AppointmentRequired": false,
  • "AppointmentStatus": "Requested",
  • "AppointmentDate": "2019-08-24T14:15:22Z",
  • "PartnerCarrierName": "string",
  • "PartnerCarrierSCAC": "string",
  • "CrossBorder": false,
  • "CrossBorderStatus": "Bond",
  • "CrossBorderEntryNumber": "string",
  • "PODAvailable": false
}

Shipment information by BOL Number

Results for a single shipment that is an exact match.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
bolNumber
required
string
Example: 123456789

The BOL Number associated with the shipment.

originPostalCode
required
string
Example: 1234512345

The Origin Postal Code associated with the shipment.

Responses

Response samples

Content type
application/json
{
  • "ProNumber": "string",
  • "ReferenceNumbers": null,
  • "UniqueID": "string",
  • "UpdatedPro": "string",
  • "PayType": "string",
  • "ShipType": "string",
  • "PickupAddress": null,
  • "BillToAddress": null,
  • "BillToAccountNumber": "string",
  • "ConsigneeAddress": null,
  • "DESaccessorial": [
    ],
  • "DESLimitedAccess": null,
  • "TimeCriticalType": null,
  • "TimeCriticalInfo": null,
  • "GrossWeight": 0,
  • "Commodities": null,
  • "HandlingUnits": null,
  • "ShipmentLocation": null,
  • "ShipmentMilestoneStatus": "Picked-up",
  • "ShipmentMilestoneStatusLong": "string",
  • "ShipmentTerminalInfo": null,
  • "TimeZoneOfShipment": "string",
  • "UpdatedETA": "2019-08-24T14:15:22Z",
  • "EstimatedStandardDay": 0,
  • "EstimatedDeliveryDate": "2019-08-24T14:15:22Z",
  • "OFDStopsAway": 0,
  • "Reconsignment": false,
  • "ShipmentShortage": false,
  • "ShipmentDamage": false,
  • "AllShortOrLostShipment": false,
  • "Late": false,
  • "DelayReasonCode": null,
  • "AppointmentRequired": false,
  • "AppointmentStatus": "Requested",
  • "AppointmentDate": "2019-08-24T14:15:22Z",
  • "PartnerCarrierName": "string",
  • "PartnerCarrierSCAC": "string",
  • "CrossBorder": false,
  • "CrossBorderStatus": "Bond",
  • "CrossBorderEntryNumber": "string",
  • "PODAvailable": false
}

Shipment information by the PO Number.

Results for a single shipment that is an exact match.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
poNumber
required
string
Example: 123456789

The PO Number associated with the shipment.

destinationPostalCode
required
string
Example: 1234512345

The Destination Postal Code associated with the shipment.

Responses

Response samples

Content type
application/json
{
  • "ProNumber": "string",
  • "ReferenceNumbers": null,
  • "UniqueID": "string",
  • "UpdatedPro": "string",
  • "PayType": "string",
  • "ShipType": "string",
  • "PickupAddress": null,
  • "BillToAddress": null,
  • "BillToAccountNumber": "string",
  • "ConsigneeAddress": null,
  • "DESaccessorial": [
    ],
  • "DESLimitedAccess": null,
  • "TimeCriticalType": null,
  • "TimeCriticalInfo": null,
  • "GrossWeight": 0,
  • "Commodities": null,
  • "HandlingUnits": null,
  • "ShipmentLocation": null,
  • "ShipmentMilestoneStatus": "Picked-up",
  • "ShipmentMilestoneStatusLong": "string",
  • "ShipmentTerminalInfo": null,
  • "TimeZoneOfShipment": "string",
  • "UpdatedETA": "2019-08-24T14:15:22Z",
  • "EstimatedStandardDay": 0,
  • "EstimatedDeliveryDate": "2019-08-24T14:15:22Z",
  • "OFDStopsAway": 0,
  • "Reconsignment": false,
  • "ShipmentShortage": false,
  • "ShipmentDamage": false,
  • "AllShortOrLostShipment": false,
  • "Late": false,
  • "DelayReasonCode": null,
  • "AppointmentRequired": false,
  • "AppointmentStatus": "Requested",
  • "AppointmentDate": "2019-08-24T14:15:22Z",
  • "PartnerCarrierName": "string",
  • "PartnerCarrierSCAC": "string",
  • "CrossBorder": false,
  • "CrossBorderStatus": "Bond",
  • "CrossBorderEntryNumber": "string",
  • "PODAvailable": false
}

Shipment information by account number and by date range.

Shipment information by account number and within a certain date range with a logged in account

Authorizations:
bearerAuthapiKeyAuth
path Parameters
accountNumber
required
string

The Account Number associated with the shipment.

startDate
required
string <date-time>

The pick-up start date of a range to search for shipments

endDate
required
string <date-time>

The pick-up end date of a range to search for shipments

Responses

Response samples

Content type
application/json
{
  • "ProNumber": "string",
  • "ReferenceNumbers": null,
  • "UniqueID": "string",
  • "UpdatedPro": "string",
  • "PayType": "string",
  • "ShipType": "string",
  • "PickupAddress": null,
  • "BillToAddress": null,
  • "BillToAccountNumber": "string",
  • "ConsigneeAddress": null,
  • "DESaccessorial": [
    ],
  • "DESLimitedAccess": null,
  • "TimeCriticalType": null,
  • "TimeCriticalInfo": null,
  • "GrossWeight": 0,
  • "Commodities": null,
  • "HandlingUnits": null,
  • "ShipmentLocation": null,
  • "ShipmentMilestoneStatus": "Picked-up",
  • "ShipmentMilestoneStatusLong": "string",
  • "ShipmentTerminalInfo": null,
  • "TimeZoneOfShipment": "string",
  • "UpdatedETA": "2019-08-24T14:15:22Z",
  • "EstimatedStandardDay": 0,
  • "EstimatedDeliveryDate": "2019-08-24T14:15:22Z",
  • "OFDStopsAway": 0,
  • "Reconsignment": false,
  • "ShipmentShortage": false,
  • "ShipmentDamage": false,
  • "AllShortOrLostShipment": false,
  • "Late": false,
  • "DelayReasonCode": null,
  • "AppointmentRequired": false,
  • "AppointmentStatus": "Requested",
  • "AppointmentDate": "2019-08-24T14:15:22Z",
  • "PartnerCarrierName": "string",
  • "PartnerCarrierSCAC": "string",
  • "CrossBorder": false,
  • "CrossBorderStatus": "Bond",
  • "CrossBorderEntryNumber": "string",
  • "PODAvailable": false
}

Notifications

Subscribe/unsubscribe shipment notifications to webhook.

Subscribe to shipment events

Endpoint to allow subscribing to real-time webhook events. You will need to provide a POST endpoint to consume this information.

The various notification objects can be found at the bottom of the page under the schemas section with the objects starting with 

Notification_
or 
Notification_Exception_
or 
Notification_WorkflowException_
.

You will receive a Transaction ID that you can use to unsubscribe later if needed.

Authorizations:
bearerAuthapiKeyAuth
Request Body schema: application/json
required
referenceNumbers
Array of strings

An array reference numbers to identify shipments to subscribe for events

webhookUrl
string

URL for the webhook to listen for shipment events.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "referenceNumbers": [
    ],
  • "webhookUrl": "example-value"
}

Response samples

Content type
application/json
Example
{
  • "message": "Subscription completed",
  • "transactionId": "TXN-123456"
}

Callback payload samples

Callback
POST: /callbackUrl
Content type
application/json
Example
{
  • "proNumber": "string",
  • "shipmentReferenceNumbers": null,
  • "shipmentMilestoneStatus": "Picked-up",
  • "TimeZoneOfShipment": "string",
  • "UpdatedETA": "2019-08-24T14:15:22Z",
  • "notificationMessage": "string",
  • "terminalStatus": "Arrived",
  • "terminaltype": "origin",
  • "terminalAddress": null,
  • "trailerNumber": "string",
  • "countsToDelivery": [
    ],
  • "UpdatedPro": "string",
  • "PartnerCarrierName": "string",
  • "PartnerCarrierSCAC": "string"
}

Unsubscribe from shipment events

Endpoint to allow unsubscribing from real-time webhook events.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
transactionId
required
string or integer

The transaction ID that was previously received during subscription that you wish to unsubscribe from.

Responses

Public Shipment Status Queries

Get shipment information with an identifying number.

Shipment information by Pro Number

Results for a single shipment that is an exact match.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
proNumber
required
string
Example: 123456789

The carrier assigned Pro Number associated with the shipment.

Responses

Response samples

Content type
application/json
{
  • "ProNumber": "string",
  • "ShipmentMilestoneStatus": "Picked-up",
  • "UpdatedETA": "2019-08-24T14:15:22Z",
  • "EstimatedStandardDay": 0
}

Shipment information by BOL Number

Results for a single shipment that is an exact match.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
bolNumber
required
string
Example: 123456789

The BOL Number associated with the shipment.

originPostalCode
required
string

The Origin Postal Code associated with the shipment.

Responses

Response samples

Content type
application/json
{
  • "ProNumber": "string",
  • "ShipmentMilestoneStatus": "Picked-up",
  • "UpdatedETA": "2019-08-24T14:15:22Z",
  • "EstimatedStandardDay": 0
}

Shipment information by the PO Number.

Results for a single shipment that is an exact match.

Authorizations:
bearerAuthapiKeyAuth
path Parameters
poNumber
required
string
Example: 123456789

The PO Number associated with the shipment.

destinationPostalCode
required
string
Example: 1234512345

The Destination Postal Code associated with the shipment.

Responses

Response samples

Content type
application/json
{
  • "ProNumber": "string",
  • "ShipmentMilestoneStatus": "Picked-up",
  • "UpdatedETA": "2019-08-24T14:15:22Z",
  • "EstimatedStandardDay": 0
}