This article serves as a concise guide to navigating the System Logs page within the Shipment Detail page.
System Logs are available for all shipments, irrespective of their entity type. A comprehensive record of all requests and responses is maintained here. Users can cross-check any doubtful instances or errors with the data available on this page. Logs capture all events related to a specific shipment, and users have the option to download the data in the form of a JSON file to their system.
The type of logs can encompass a variety of events, including but not limited to label requests, shipment creation, shipment confirmation, webhook calls, automation rule assignments, and manual or automatic status updates.
Permissions: All users with roles other than Viewer are able to see the System Logs page.
Exploring the System Logs Page
1. Navigate to Shipping > Shipments on the Carriyo Dashboard. Open the desired shipment for which you want to check the system logs for. Users can switch between Summary, History and System Logs by clicking on their respective titles. The logs are arranged in chronological order, from oldest to newest.
Here, the source is the URL to where the requests are sent to.
- represents inbound logs (requests to Carriyo)
- represents outbound logs (requests from Carriyo)
There is a filter option available to show either outbound or inbound logs exclusively. Simply select the desired option from the Filter By dropdown list.
To change the number of rows displayed, change the number on the Rows per page dropdown option.
The four options on the top denotes refresh, filter, export and menu/more options.
2. Click the icon in the More Details column for a full breakdown of the log's technical details. It will display a pop up that will look something like this. Scroll down to see the entire log.
The two options provided on the popup in their respective order are —
- Copy as cURL: This feature allows users to copy the cURL command for the log in question to the clipboard.
- Save raw logs: This feature allows users to save the log as a txt file directly onto the system, preserving the same format displayed here.
Each event or request is associated with a corresponding code. The categories of code are explained below. N/A signifies that the event is not a request (usually for Automation Rule Assignment).
-
2xx
success status codes confirm that the request worked as expected. -
4xx
error status codes indicate an error because of the information provided (for example, a required parameter was omitted or when a phone number is invalid). -
5xx
error status codes are rare and indicate an error with Carriyo's servers.
To understand shipment summary and shipment history, visit the dedicated articles for each.
Comments
0 comments
Please sign in to leave a comment.