Do you need to view the raw data behind a shipment?
The built-in Developer Tools provide a simple way to access the full payload for any shipment using its unique Shipment ID. This can be invaluable for troubleshooting, integrations, or simply understanding the complete data associated with a shipment.
1. Enable Developer Tools:
- Navigate to "Configuration" -> "Settings" in the Ship UI.
- Locate the "New Booking" section.
- Check the box labeled "Show developer tools."
- Save your changes. The Developer Tools panel will now appear at the bottom of the Outbox view.
2. Find your Shipment ID:
- Go to the "Outbox" tab.
- If the "Shipment id" column isn't visible, click the three-dot menu on the right side of the table header and select "Configure." In the dialog, enable the "Shipment id" column and save.
- Locate the shipment whose payload you need and note its Shipment ID.
3. Retrieve the Payload:
- Expand the "Developer Tools" panel.
- In the "Command" dropdown, select "GetShipment."
- In the "Data" field, update the actual Shipment ID
- Click the "Send" button.
For example:
{
"ShpCSID": 803038
}
4. View the Response:
The complete shipment payload will appear in the "Response" field in JSON format. This data contains all the details associated with the shipment.
5. Trim the JSON object
While the full shipment response provides comprehensive information, you might not need all of it for certain use cases. Trimming the JSON to include only relevant data makes it more manageable and efficient for reuse. Normally any data you did not fill in when creating the shipment initially can be left out.