Each application is a unique set of API keys and configuration settings needed for making requests to Ryder's APIs.
The TM Shipment API offers the ability for customers to register for event notifications that can be delivered either to an email or a webhook at their discretion. This allows customers to stay updated on specific events related to their shipments and loads, improving their ability to respond in real-time to any changes or updates.
View the API Reference for detailed specifications.
You must be a registered subscriber to the TM Shipment API in order to receive notifications.
Notifications are only sent when there is a qualifying event on a shipment or load that you are tracking.
To start receiving event notifications, you'll need to register your notification preferences. This can be done through the Notification Preferences API, where you can specify which types of events you want to be notified about and how you’d like to receive the notifications (via email or webhook).
Email Notifications: You’ll receive email updates for the selected events.
Webhook Notifications: A webhook will be triggered to send you updates directly to your system.
Registering Preferences: You register your notification preferences by making an API call to indicate which events you want to be notified about and whether you prefer email or webhook notifications.
Event Triggering: Notifications will only occur if a qualifying event happens on a shipment or load that you are subscribed to. For example, if the status of a shipment changes to "Delivered" or "Cancelled", you’ll receive a notification.
Payload Delivery: Once an event occurs, the system will send a notification containing the relevant details, either to your email address or to your webhook endpoint.
You can subscribe to receive notifications for the following shipment and load statuses:
Status Code Status Description Shipment Load
------------------------------------------------------
1 Open x x
2 Picked Up x x
3 Delivered x x
4 Closed x x
5 Cancelled x x
6 Planned - x
7 Tendered - x
8 Tender Accepted - x
9 Tender Rejected - x
10 Hold x -
11 Approved x -
12 Declined x -
13 Draft x -
14 Hold_For_Review x -
15 Error x x
16 In_Queue x x
17 Lights_Out_Draft x -
18 Partial Picked Up x x
19 Partial Delivered x x
20 On Load x x
21 Delete x x
Track Shipment Status: Receive updates when your shipments change status (e.g., from "Open" to "Picked Up").
Cancelled Orders: If a customer cancels an order, you can receive notifications when the shipment is also cancelled in the system.
Partial Pickups or Deliveries: Stay informed about partial deliveries or pickups, ensuring you know exactly when your goods are partially picked up or delivered.
Once you’ve subscribed to specific events, the notifications will contain the following key details:
Transaction Type: The type of transaction being monitored ("Shipment" or "Load).
Event: The event that triggered the shipment or load notification (e.g., "Delivered", "Cancelled").
Resource Link: A link to the resource that was affected by the event.
Timestamp: When the event occurred.
Event Messages: Depending on the event, additional details may be included, such as any warnings or errors that occurred.
Here is an example of an email notification:
If you choose webhook notifications, you will receive the following structured data in the payload.
Shipments:
{
"RyderAlert": {
"transactionType": "Shipment",
"event": "Shipment updated",
"shipmentDetails": "https://api.ryder.com/tmshipment/v1/shipments/123456",
"timestamp": "2024-09-03T21:59:00-06:00",
"shipmentMessages": {
"warnings": [
"Property 'TotalAmount' not present."
],
"errors": []
}
}
}Loads:
{
"RyderAlert": {
"transactionType": "Load",
"event": "Load updated",
"loadDetails": "https://api.ryder.com/tmshipment/v1/loads/123456",
"timestamp": "2024-09-03T21:59:00-06:00",
"loadMessages": {
"warnings": [
"Property 'TotalAmount' not present."
],
"errors": []
}
}
}I’m not receiving notifications:
Ensure your notification preferences are correctly configured, and double-check that your email or webhook URL is accurate.
I don’t know if the notification was triggered:
Verify that the event you subscribed to (e.g., "Shipment Delivered") has occurred. You can check this in your shipment's status history.
Test notification delivery by manually triggering an event in your system (e.g., changing the shipment status) and checking whether the notification is sent to your specified email or webhook.
How do I know which events will trigger a notification?
Review the Event Types section to see which shipment and load statuses trigger notifications.
Can I unsubscribe from event notifications?
Yes, update your notification preferences to stop receiving specific event notifications.