Integration Requests

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 formats for receiving data.
An integration setup is the transfer of data between your Transvirtual account and another 3rd party system.

What do you need to provide?

  1. Who is the customer and who is the agent?
    When requesting integrations, we need to know whether the 3rd party will be the customer sending consignment data to you (Customer Integration) OR if they are the agent/supplier that will be performing deliveries on behalf of your business (Agent Integration). This is important because it determines the data flow direction and thus how the integration will be configured.
    We also need to know preferred methods for sending and receiving data as explained in the next section (do you want to send/receive data via FTP or Email using CSV or XML etc). 

  2. What email address is best for our integrations team to contact the other party?
    We need at least one email contact for someone from the 3rd party (entity you are trying to integrate with) as we will need to liaise with that person to get this setup for you. Our integrations team will communicate via email to ensure that all setup procedures are completed accurately.
    If needed you can provide phone numbers, however we need at least one email contact (including both the email address and the name of the contact person) is essential.

  3. Integration specific information such as Service Levels, Account Numbers, etc
    Some integrations (such as AusPost/StarTrack) require you to establish an account with the respective service provider. In such cases we may require specific information such as an Account Number and the Service Levels that this entity will offer you. Companies like AusPost/StarTrack provides various Service Levels and each service level assigned a Service Code. We need to know this type of information as we need to be able translate the data in Transvirtual into a format that the other 3rd party system can understand and accept. 
    Links to the requirements for our integrations can be found at the bottom of this article. These links provided further detail on the information needed for the integration you are requesting. However, if you are not sure about the technical information we require, please feel free to reach out to the Transvirtual support team (support@transvirtual.com) who will be happy to assist.

What are some of the data formats that Transvirtual can accept?

If you are requesting an integration where you are the agent and will be receiving consignment data, then the below links will assist as they outline common data formats that Transvirtual can use to import consignments into your account.
  1. XML
  2. API
  3. CSV 
Both XML and CSV file types can be accepted via SFTP/FTP or Email.

API requires an Auth Token (key) to be provided by you to the other party, as they will need it to access and direct the data into your account. This key is unique to your account and can be found on the Global Setup page of Transvirtual under the Settings menu (located at the bottom-right hand side of the general tab in the API section).
Please provide this information on standard data formats to your contact for the other party (who you're integrating with). This will assist to speed up the integration request with the Transvirtual integrations team.
We also need the other party to provide any documentation they have regarding the integration you are requesting, if this is provided prior to the request this will facilitate a quicker completion of the setup and ensure that our integrations team has all the required information from the start.

Common Integrations

Below are the articles links for integrations. 
  1. Customer Integrations / Agent Integrations
  2. Customer/Agent required Attributes


    • Related Articles

    • Integration - General Information

      Cross Client Data/Integration Requests Transvirtual works with a range of interconnected clients and prides ourselves in the robustness and easy roll out of our integrations. Sometimes we are approached with requests to: Confirm the presence/absence ...

    • Integration Required Information (Agent/Customer)

      This article gives you an idea about the attributes used as a validation, Authorization, Specification of Services, provided to/given by partner when setting up an integration between the partner and Transvirtual, refer below table for more ...

    • 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 Transvirtual. - You have their ...

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

    • Transvirtual Standard POD Import (XML V1.0)

      POD Import Supplying your POD's in this format provides easy and detail format for integration. This can be accepted in FTP or Email. Advise your integration contact of your preferred method. <PODs> <PODEvent> ...