API - ShipEngine

API - ShipEngine

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.

Notes

- The following information is only applicable if you are already using ShipEngine. If you are not currently integrated with ShipEngineTransvirtual’s 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). 

Info
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.
Warning
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.

Extra Information

Link to 3rd party API Reference 

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.
Notes
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 

    • Related Articles

    • Introduction to the Transvirtual API

      Introduction The REST API is an HTTP interface to TransVirtual. Using REST, you use standard HTTP requests to create, fetch and delete data from your TransVirtual account. You can use any toolkit that supports HTTP to use the REST API. The REST API ...
    • Current Agent Integrations

      Current Agent Integrations Below is a list of current integrations available with TransVirtual. This list is always growing so if you can't see one, please contact our support team who can advise. Agent - This is where the company listed can receive ...
    • Current Customer Integrations

      Below is a list of current integrations available with Transvirtual. This list is always growing so if you can't see one, please contact our support team. Customer - This is where the company listed can send consignment/manifest data to your ...
    • General Import Information

      Introduction to Imports The import framework within TransVirtual allows you to import your data in a number of ways. This framework will expand as technology develops. There are 6 import frameworks as below. Remote FTP TransVirtual Hosted FTP Server ...
    • Integration Requests

      When requesting an integration setup, there is certain information that the Transvirtual team needs to know to process your request. This article will further explain the information we require and also include links to our standard accepted data ...