API - ShipEngine
Transvirtual integrates with ShipEngine to generate shipping labels and handle shipping-related errors. This article covers how to map rates, create a consignment, cancel a consignment, and track a consignment using the ShipEngine API endpoints.
- The following information is only applicable if you are already using ShipEngine. If you are not currently integrated with ShipEngine, Transvirtual has an extensive API that you can use for integration, click here to learn more.
- If you're a carrier and want to be integrated with the ShipEngine platform, please contact Transvirtual Support at Support@transvirtual.com for assistance.
Create a Label/Consignment
This function is used to create label/ consignments in Transvirtual. Once created, it returns a consignment number, which is also used as the Tracking Number in the response.
API Endpoints to Create a Label/Consignment
The table below shows the expected endpoints that will be mapped when requesting to create a consignment/Create a Label:
Endpoint | Method | Request URL | Description |
Create Labels | POST | v1/labels | Request to create a label coming from ShipEngine. |
Extra Information
Link to 3rd party API Reference
Void Label/Cancel a Consignment
This function cancels an existing consignment using its Consignment Number (which is also used as the Tracking Number).
In Transvirtual, cancelling a consignment does not remove it from the database; it simply updates the consignment’s status. Cancelled consignments no longer appear by default but can still be viewed by applying the "Cancelled" status filter, as shown below.
Transvirtual may not allow cancellation of the consignment on certain conditions. i.e. if it has an invoice that is approved locked.
API Endpoints to Void a Label (Cancel a Consignment)
1. The table below shows the expected endpoints that will be mapped when requesting to delete consignment/Void a Label:
Endpoint | Method | Request URL | Description |
Void Labels | PUT | v1/labels/{label_id}/void | Request to cancel label coming from ShipEngine. |
Track Package
This function accepts a tracking number (which is equivalent to a Consignment Number) as input. It then retrieves the shipment status and maps it to the standardized status codes defined by ShipEngine’s API specifications.
Status Mapping Summary:
This table shows how different shipment statuses from Transvirtual are mapped to equivalent statuses in ShipEngine.
| Transvirtual Status | Mapped ShipEngine Status |
| Created, Pickup Received, Hold, In Depot, and Assigned | Accepted |
Pending On Delivery, Driver Pickup Ack, Pending Driver Pickup Ack, On Delivery and In-Transit | In-Transit |
Delivered, and Fully Complete | Delivered |
Cancelled | Exception |
In-Depot and Returning to Depot | Delivery Attempt |
API Endpoints to Track a Label/Consignment
1. The table below shows the expected endpoints that will be mapped when requesting to track Label/Consignment.
Endpoint | Method | Request URL | Description |
Track Labels | GET | v1/tracking | Request to track a label/consignment coming from ShipEngine. |
Extra Information
Link to 3rd party API Reference
Rates Mapping
This function is used to retrieve price estimates from the Transvirtual system. The estimates are calculated based on predefined rate cards, which are configured through the Transvirtual dashboard or API. These rate cards include parameters such as service type, distance, weight, dimensions, and other relevant shipping criteria.API Endpoints
The table below shows the expected endpoints that will be mapped:
Endpoint | Method | Request URL | Description |
GetRates | POST | v1/rates | Request rates from ShipEngine. |
Extra Information
Link to 3rd party API Reference