An integral part of Carriyo is the status mappings between carriers and Carriyo's internal statuses. When carriers integrate with Carriyo, it can be either through a custom integration or via Plug n Play.
For each carrier that is not integrated via Plug n Play, a status mappings file is maintained. These files can be downloaded from the Downloads section under Settings. Visit this article to learn how to download carrier status mappings files.
Whenever a carrier sends updates, if the status is recognized (i.e., it exists in the mappings file), it will be updated in Carriyo. Conversely, if the status is unrecognized, it will be ignored. Mappings are case sensitive. Carrier statuses can be text description, code, or a combination of both. Additionally, carrier statuses can also be mapped to a combination of Carriyo statuses and reason codes.
Plug n Play carriers use the same statuses as Carriyo to update shipments, so no mapping checks are required. However, these updates must follow the correct order of status transitions. Visit this article to see the status flow in Carriyo.
Understanding carrier status mappings
1. The Summary tab in the Shipment Detail page displays the latest carrier status update under the Carrier Info section.
You can view the Change Logs to see all changes made to the shipment and the source responsible for each change. The Change Logs display both mapped and unmapped statuses, providing an overall view of the changes made to the shipment.
2. The History tab keeps a record of all relevant updates made to the shipment. The source for these status updates is the carrier. Each carrier status update includes the timestamp when Carriyo received the update, the corresponding carrier status, and the timestamp when the carrier updated it on their side. For example, the carrier status 'Arrived at Facility' is mapped to the Carriyo status 'In Transit,' and the date listed below indicates the time of the carrier's update on their systems.
3. Similarly, in the System Logs tab, you can find more details about each of these events. While the format of the carrier's updates may vary from one carrier to another, they generally contain the same information. A carrier status update event log will include the Carriyo status (after mapping check), the carrier status, a description (optional), and the update timestamp. The timestamp received in the response indicates when the carrier updated the status on their side.
Carriyo uses two kinds of shipment tracking - carrier real time updates & Carriyo scheduled tracking. Refer to this article in our docs to learn more about this in detail.
Carrier status update (real time via callbacks):
Carrier status update (Carriyo scheduled tracking):
Inconsistencies can occur in the following cases:
- The carrier API fails to provide timely updates via webhooks or callbacks. This issue only applies to carriers that support real-time updates.
- The carrier updates the mappings on their side without informing Carriyo.
- The carrier does not respond in a timely manner to scheduled tracking requests initiated by Carriyo.
Comments
0 comments
Please sign in to leave a comment.