Voila Shipping Documentation – Fast & Reliable Shipping Solutions Worldwide Skip to main content

Advanced Mode

Introduction toVoilaLogo.png

Welcome to Voila, your all-in-one solution for courier label creation, tracking, and shipping automation. This guide will walk you through the essential steps to set up your API account, install couriers, and create smart shipping rules.

Voila acts as a translator between your business and courier services, simplifying complex API requests and standardising responses across different courier platforms. 

 VoilaLogo.pngSimplifies Shipping & Maximises Efficiency

At Voila, we handle the complexity of courier integrations so you don’t have to. Our system translates your shipping requests into the various formats required by couriers, standardising their responses to ensure consistency and ease of use.

With intelligent shipping automation, you can seamlessly switch couriers based on key factors like weight, postcode, collection times, or even location type — Voila helps you with the following: 

⚙️  No IT Integration Hassles – If a new courier offers better rates, you can onboard them instantly. Our pre-built APIs eliminate the need for costly development, allowing you to start shipping immediately.

⚡ Optimise Costs & Delivery Speeds with Smart Rules, take full control of your shipping strategy with Smart Rules, an intuitive system that dynamically selects the best courier based on key parameters like cost, speed, weight, postcode, and pickup times.

🔒 Secure & Scalable API – We safeguard your courier credentials by registering each account with a friendly name ("auth"), preventing sensitive data from being transmitted. Whether you manage a single site or multiple locations, our system ensures your requests are routed correctly and securely.

🛡️ Security Is Our Top Priority – every interaction is encrypted using advanced HTTPS protocols, protecting your data with the highest standards of online safety.

At Voila,Voila, we’re here to streamline your shipping, save you time, and help you scale effortlessly. Let’s simplify logistics together. 🚛

🚀 Quick Start Guide: Setting Up Postman & Voila API

To install Postman, visit the official Postman website at 

Postman Downloads. Once there, you'll find the download button to choose the version compatible with your operating system—whether it's Windows, macOS, or Linux. After downloading the installation file, locate it in your designated download directory and install it by following the on-screen instructions.

If you haven't already done so, please create a Postman account to access its full features and services. You can quickly sign up for an account by visiting the Postman signup page at Postman Account Signup. Once you've installed Postman and created an account, you can efficiently utilise Voila.

🛠 Installing Postman

  1. Download Postman: Visit the Postman Downloads page and choose the version for Windows, macOS, or Linux.

  2. Install Postman: Locate the downloaded file and follow the on-screen installation instructions.

  3. Create an Account: Sign up at Postman Account Signup to access all features.

⚙️ Setting Up Postman for Voila API

  1. To accessImport the documentationDocumentation: forVisit the Voila, visitVoila thisAPI pagedocumentation  and save it to your Postman account.

    1. Click the "‘Run in Postman"Postman’ button(top-right incorner of the screen'sscreen).

      top right corner.

    2. Select Your Platform: Choose the second option and select "Postman for Windows/Linux/MacmacOS."

      OS."

    3. Pick youra workplaceWorkspace: forSelect importingwhere to import the collection and confirmconfirm.

      your selection.
    4. Upon completion,

      Access you'llAPI Calls: Once imported, find the Voila API calls and examples in yourPostman.

      Postman account.

     

    🔑 Creating an API Account Using(GUI GUIMethod)

    Before diving into features, settingSetting up youran API account withinin Voila is essential. This account, is the foundationkey ofto yourmanaging shipments efficiently, it enables access to shipping operations, allowing you to access and utilise the platform's tools effectively. Fromlike label creation toand shipmenttracking. tracking, everythingEverything starts withhere, your API account. It's the first step towards optimisingstreamlining your logistics process.from the get-go.

    1. ForNavigate instance, you can create groups within Voila and assignto API accountsAccounts accordingly.in ThisVoila.

      feature
      2. proves
    2. particularly

      Create usefulGroups (Optional) for businesses operating acrossmanaging multiple locations,locations.

      allowing
      3. for
    3. more

      Install organisedCouriers trackingPer andAccount usage.to Each API account can install couriers independently, ensuring that courier connections andkeep settings are unique to the account. Also, by creating separate API accounts and groups for different locations or offices, businesses gain the flexibility to tailor their shipping solutions to specific needs. Grouping locations helps you better manage your workflow and simplify operations.unique.

      Here's

      4. a
    quick overview of the
    🗂 API Accounts page:

    Overview:

    • API Account: Displays theaccount namenames.

      of your API account.

    • Keys & Tokens: View and View/regenerate your API keyscredentials.

      and tokens here.

    • Shipments: Access a list ofTrack all shipments sent via this APIaccount.

      account.

    • Registered Auths: Manage all courier integrationsintegrations.

      for this API account. Add new integrations or manage existing ones.

    • Status: Activate or Activate/deactivate the API accountaccounts.

      as needed.

    • Actions: Move theaccounts APIbetween account to a different API groupgroups or delete thethem.

      account.

    Refer to our dedicated📌 For detailed setup, check the API Accounts documentationDocumentation. for detailed guidance on setting up your API account and obtaining your token.

    Before configuring your collection variables in Postman, you must refer to the API Accounts documentation page for setup instructions on creating an API account. Once you have set up an API account, you can retrieve the necessary "api-user" and "api-token" variables from there.

    API Accounts.png


    🔧 Configuring Postman Collection Variables in Postman

    After obtaining your API username and token, configuringset them up in PostmanPostman. is the next step. By savingStoring them as collection variables,variables yousimplifies canrequests simplifyand eliminates the processneed and avoidfor repeated entriesentries. whenSince calling API endpoints. Postman will retain this information, allowing you to focus solely on making endpoint calls. Thesethese keys are already registeredincluded in the collection;collection, youupdate havethem toas edit them.needed.

    1. Navigate

      Go to the‘Variables’ "Variables"(centre tab atof the screen's centrescreen when viewing the collection.collection).

    2. Input the

      Enter requiredAPI information as follows:Credentials:

      • Variable: api_url

      • Variable:Retrieve API Details api-user:

        • Initial Value:

          Find Insertapi-user your API username

        • To find the API username, go to theunder "API Accounts" page and locate the name under the→ "API Account" column.

      • Variable:

        Find api-token

        • Initial Value: Insert your API token
        • To obtain the API token, visit the "API Accounts" page. Once you click the button highlighted in theunder "Keys & Tokens" column, the token will be located at the bottom of the window that pops up, under the "Token" column.

    3. Click the‘Save’ "Save" button in the screen's top (top-right corner.corner).



    📡 Creating an API Account Using(API the APIMethod)

    TheSetting initial step to familiarise yourself with the API is creatingup an API account viathrough the API interface.interface Thisis straightforwarda simple process facilitatesthat futureenhances workflow organisation,efficiency, mainlyespecially when collaborating with multiple team members across variousdifferent locations.

    1. Expand the

      Go "to ‘Account & Management"Management’ folder,folder thenin choosePostman.

      "

    2. Select ‘Create a New API User"User’.

      on the left side of your screen.

    3. Customise the requestRequest: according to your preferences. For instance, you may specify onlyEnter the "name"name field while(other removingfields others.are Voilaoptional).

      will then generate a key and token for you.

    4. Click ‘Send’ (top-right corner).

    5. Retrieve API Keys from the "Send"response.

      button at the screen's top right corner.
    6. The response

      Confirm toAPI yourAccount requestin willVoila appear at the bottom of the page. You can save this information for later use.

    7. Navigate tounder "API Accounts"Accounts."

      within Voila to view the newly created API account in the graphical user interface (GUI).

    Getting a List of Couriers

    To view the available couriers along with their names and details,

    you can utilizeutilise this endpoint to access all pertinent information.information It ison how couriers are identified within the API and how to reference them later.

    Follow these steps:

    1. Expand the "Account & Management" folder, then select "List Couriers" from the left-hand menu.
    2. Click "Send" to submit the request.
    3. The request-response contains a list of available couriers. Each courier is identified by the string contained within the "key" attribute.

    🚚 Retrieving a List of Couriers

    Utilise this endpoint to obtain key details on courier identification within the API and how to reference them later.

    1. Expand ‘Account & Management’.

    2. Select ‘List Couriers’.

    3. Click ‘Send’.

    4. View Response: The list of couriers is displayed with unique keys.



    📜 Displaying Required Courier Parameters

    Before proceeding to install couriers, it's essential to understand the parameters and information they require for installation. You can easily accomplish this by following these steps:

    1. Expand the "‘Account & Management"Management’.

      folder,
      2. then
    2. navigate

      Select to "‘Get Auth Rules"Rules’.

      in the left-hand menu.
    3. Adjust the

      Modify URL with the courier forkey:  which you need information. Replace the courier key in the middle as indicated:


      • {{api_url}}/API/couriers/v1/ENTER-YOUR-COURIER-KEY-HERE/HERE/register-auth-rules

    4. Click the‘Send’.

      "Send" button at the page's top right corner.
    5. The

      View Required & Optional Parameters - the request-response contains the required and optional keys and their expected values, whether strings, integers,integers or dictionaries. 

     

    Installing a Courier Through the API

    Now that you know the fundamentals of API user setup and couriers, let's guide you through creating your initial courier connection. Each API account can independently install couriers, ensuring that courier connections remain distinct to each account. This meticulous level of control empowers you to tailor your shipping configuration to the specific requirements of your business segments.

    To install a courier via the API, follow these steps:

    1. Expand the "Account & Management" folder, then navigate to "Register Auth" in the left-hand menu.
    2. Adjust the request URL, such as replacing the courier name with your desired choice. In this demonstration, we'll install DHL.
    3. Customise the request data according to the courier's specific requirements. You can refer to the previous section if you need guidance on this.
    4. Click the "Send" button at the screen's top left corner.
    5. Review the request response to determine whether the installation was successful or unsuccessful.
    6. To view the newly installed courier, proceed to Voila and select "API Accounts" from the left-hand menu.
    7. In the API account where you installed the courier, click the "View Registered Auths" button.
    8. You can confirm that DHL is listed in the installed courierscourier's section, indicating a successful installation process.

    📦 CreatingInstalling Smarta RulesCourier via API

    OnceNow you'vethat setyou upknow the fundamentals of API user setup and couriers, let's guide you through creating your initial courier services,connection. theEach nextAPI stepaccount iscan independently install couriers, ensuring that courier connections remain distinct to configureeach smartaccount. shipping.

    This

    Smartmeticulous shippinglevel offersof businessescontrol an efficient approach to managing logistics and parcel delivery operations. It also simplifies selecting carriers and services based on predefined criteria using a user-friendly interface and API integration. 

    Within the smart shipping interface,empowers you can create rule groups and smart rules to tailor your shipping strategiesconfiguration to the specific needs.requirements Itof allowsyour business segments.

    1. Expand ‘Account & Management’.

    2. Select ‘Register Auth’.

    3. Modify Request Data with the courier’s specific details.

    4. Click ‘Send’.

    5. Verify Response for precisesuccess.

      control
      6. over

    6. Check Installed Couriers in Voila under "API Accounts."

     

    🤖 Creating Smart Rules

    Smart shipping methodologies,enables cateringautomated tocarrier diverseselection customerbased preferenceson andpredefined optimising efficiency.rules.

    1. ToAccess learnthe howSmart toShipping Interface.

    2. Create Rule Groups & Smart Rules based on shipping parameters.

    3. Optimise Costs & Delivery Speeds through automated courier selection.

    📌 For a step-by-step guide, check the Smart Shipping Documentation.

    You’re now set up Smartwith shipping,Postman visitand theVoilaLogo.pngAPI! dedicated guide🚀 onHappy thisshipping! page.

Back to top