A Correlation ID is a unique code automatically assigned to each request in Ship. It is not an error code, but if an error occurs, the ID appears in the message and helps trace the request in system logs.
Why is it useful?
- Troubleshooting – Lets support teams quickly locate the exact request and error in the logs.
- Traceability – Tracks a request’s full journey through the system.
If an error occurs, you might see:
"Error message — Correlation ID: ABC123XYZ"
Copy the ID exactly and share it with your Ship technical consultant.
Use case
You send a shipment request → Error occurs → Message shows:
"Shipment creation failed. Correlation ID: 987ZYX654"
Send this ID to support so they can use it to find and fix the issue more quickly. It is a good idea to always include the Correlation ID when reporting issues. It is the key to fast, accurate troubleshooting.
Example: