Introduction to the TransVirtual API

Introduction to the TransVirtual API


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 uses the standard HTTP headers and status codes, so that standard toolkits work as expected. In some areas, we have added functionality to HTTP (for example, headers to support authentication). In these cases, we have done our best to add the new functionality in a way that matched the style of standard HTTP usage.
To work with this API, you will need to understand the authentication requirements as every call to this API will require it. Please keep this in mind as you review the API, as it will be assumed knowledge all areas.
Currently only SSL connections are allowed in TransVirtual API endpoints. Communicating over SSL preserves user privacy by protecting information between the user and the TransVirtual API as it travels across the public internet.
You have the option to submit and consume data from the TransVirtual API in either JSON or XML format. You also have the ability to call the API with the JSONP for cross domain requirements.

Also attached here is a Postman ( collection for your development team to work with. It has working examples on how to communicate with the API endpoints. These are variables set at the Collection level for the API key and the Customer code. You will require both of these for the postman collection to work and provide appropriate feedback.
    • Related Articles

    • 2022 Theme Update

      There is the option in the global settings to change the theme of your TransVirtual account to the new 2022 version. The toggle for this will change the colour scheme to match closely to that of the mobile application and will also include minor ...
    • TransVirtual Invoices

      Invoices TransVirtual Invoices are issued in line with our Payment Policy that can be accessed via the link on the footer of each page or by going to Invoices are weekly (Monday - Sunday) + End of ...
    • TransVirtual Rates

      TransVirtual Rates Your current rates can be found on the Rates and Modules Page (Settings > TransVirtual Account > Rates and Modules). Rates are applied as follows: Base Rate - Required Charged per consignment created, irrespective of scans or ...
    • Introduction

      In this section you will learn about performing EDI Data imports, exports and reporting. EDI Tools for importing and exporting are core to sharing information about consignments, items and scan data. In the following sections we will provide articles ...
    • Linking TransVirtual Accounts

      Linking TransVirtual Accounts Linking TransVirtual accounts is easy, by linking accounts you will be able to transmit data between yourself and your agent/customer. To link TransVirtual accounts, you need to ensure that: - The customer/agent has ...