Transvirtual integrates with ShipEngine to generate shipping labels and manage shipping-related errors. This article helps to know about how to Map the Rates, Consignment Creation, Cancel a Consignment and Track a Consignment via ShipEngine API endpoints.
- The following information is only applicable if you are already using ShipEngine. If you are not currently integrated with ShipEngine, Transvirtual’s has an extensive API that you can use for integration, click here to learn more.
Endpoint | Method | Request URL | Description |
Create Labels | POST | v1/labels | Request to create a label coming from ShipEngine. |
This function cancels an existing consignment using its Consignment Number (which is also used as the Tracking Number).
Endpoint | Method | Request URL | Description |
Void Labels | PUT | v1/labels/{label_id}/void | Request to cancel label coming from 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 |
Endpoint | Method | Request URL | Description |
Track Labels | GET | v1/tracking | Request to track a label/consignment coming from ShipEngine. |
Endpoint | Method | Request URL | Description |
GetRates | POST | v1/rates | Request rates from ShipEngine. |