Getting Started with Voila
This guide will walk you through the initial steps once you've obtained your account.

Standard Mode
Introduction to 

 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.  

 Simplifies 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, we’re here to streamline your shipping, save you time, and help you scale effortlessly . Let’s simplify logistics together. 🚛 

 Step 1: Setting Up Your API Account 

 Your API account is the foundation of your Voila setup. It enables you to: 

 

 Install and manage courier integrations 

 Create shipping labels and track parcels 

 Assign multiple API account s to different locations for better organisation 

 

 How to Set Up Your API Account 

 

 Log in to Voila and navigate to the API Account section. 

 Create a new API Group or assign it to an existing group, especially for businesses with multiple locations. 

 Create a new API account and assign it a relevant name (e.g., "Main Warehouse"). 

 Generate an API token —this will be used to authenticate your requests securely. 

 

 🔶  For more details, refer to our API Account Setup Guide . 

 

 Step 2: Registering Your First Courier 

 Each API account can independently install couriers, ensuring flexibility in managing multiple carriers. 

 How to Register a Courier 

 

 Go to the Couriers section in your Voila dashboard. 

 Select a courier from the available list (e.g., DPD, Yodel, Evri). 

 Enter the required authentication details (each courier has different requirements). 

 Assign a friendly name to the courier (e.g., "Manchester DPD Account"). 

 Click "Save" to complete the setup. 

 

 Once added, your courier is ready to process shipments! 

 🔶  Need help? Visit our Courier Setup Guide for step-by-step instructions. 

 

 Step 3: Creating Smart Shipping Rules 

 Smart Shipping allows you to automate courier selection based on predefined conditions such as weight, location, and price. 

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

 📦  Cost Efficiency – Automatically choose the most affordable courier without sacrificing service quality. Set price thresholds to ensure you’re always getting the best deal. 

 🚚  Faster Deliveries – Route shipments based on pickup availability and transit times, ensuring your parcels reach customers as quickly as possible. 

 🔄  Seamless Flexibility – Adapt on the fly! If a courier service is unavailable or offers better rates, switch effortlessly without disrupting your workflow. 

 With Smart Rules, every shipment is optimised for cost and speed , saving you time, money, and hassle. Let automation do the heavy lifting while you focus on growing your business! 💡 

 How to Create a Smart Shipping Rule 

 

 Go to "Smart Shipping" in Voila . 

 Create a new rule group (e.g., "Express" or "Standard"). 

 Add a new rule within the group:

 

 Set a priority (lower numbers run first). 

 Define supported countries (e.g., UK). 

 Exclude specific postcodes (e.g., Northern Ireland). 

 Set a maximum parcel weight and dimensions . 

 Choose a courier and backup failover service . 

 Enable return labels if required. 

 

 

 Save your rule and start automating shipments! 

 

 🔶   Explore our Smart Shipping Guide for advanced rule configurations. 

 

 Step 4: Managing Shipments & Actions 

 Once couriers are set up, you can view and manage shipments effortlessly. 

 How to View Shipments 

 

 Click "View Shipments" to see all shipment requests. 

 Filter shipments by date, courier, or status. 

 Check shipment details including tracking information and costs. 

 

 Available Actions 

 

 Cancel Shipment – Void a shipment if it's no longer needed. 

 Download Label – Retrieve shipping labels for printing. 

 Parcel Info – View package dimensions, weight, and service details. 

 Print Packing Slip – Generate and print packing lists for orders. 

 Print Commercial Invoice – Create invoices for international shipments. 

 

 🔶  For more details, refer to our Shipment Documentation. 

 

 Next Steps & Support 

 🔶 Need help? Explore more of our documentation, video walkthroughs or contact support . 🔶 Looking for more features? Check out our   Smart Shipping Guide . 

 With  , you will be set up for  seamless, efficient shipping .       

Advanced Mode
Introduction to 

 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.  

 Simplifies 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 , 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 & API 

 🛠 Installing Postman 

 

 

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

 

 

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

 

 

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

 

 

 ⚙️ Setting Up Postman for  API 

 

 

 Import the Documentation : Visit the Voila API documentation and save it to your Postman account. 

 

 

 Click ‘Run in Postman’ (top-right corner of the screen). 

 

 

 Select Your Platform : Choose "Postman for Windows/Linux/macOS." 

 

 

 Pick a Workspace : Select where to import the collection and confirm. 

 

 

 Access API Calls : Once imported, find the Voila API calls and examples in Postman. 

 

 

 

 Click to Play or Pause the Video 

 🔑 Creating an API Account (GUI Method) 

 Setting up an API account in Voila  is the key to managing shipments efficiently, it enables access to shipping tools like label creation and tracking. Everything starts here, streamlining your logistics from the get-go. 

 

 

 Navigate to API Accounts in Voila . 

 

 

 Create Groups (Optional) for managing multiple locations. 

 

 

 Install Couriers Per Account to keep settings unique. 

 

 

 🗂 API Accounts Overview: 

 

 

 API Account : Displays account names. 

 

 

 Keys & Tokens : View/regenerate API credentials. 

 

 

 Shipments : Track all shipments sent via this account. 

 

 

 Registered Auths : Manage courier integrations. 

 

 

 Status : Activate/deactivate API accounts. 

 

 

 Actions : Move accounts between groups or delete them. 

 

 

 📌 For detailed setup, check the API Accounts Documentation . 

 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. 

 

 🔧 Configuring Postman Collection Variables 

 After obtaining your API username and token, set them up in Postman. Storing them as collection variables simplifies requests and eliminates the need for repeated entries. Since these keys are already included in the collection, update them as needed. 

 

 

 Go to ‘Variables’ (centre of the screen when viewing the collection). 

 

 

 Enter API Credentials : 

 

 

 Variable: api_url → https://production.courierapi.co.uk 

 

 

 Variable: api-user → (Your API username) 

 

 

 Variable: api-token → (Your API token) 

 

 

 

 

 Retrieve API Details : 

 

 

 Find api-user under "API Accounts" → "API Account" column. 

 

 

 Find api-token under "Keys & Tokens" column. 

 

 

 

 

 Click ‘Save’ (top-right corner). 

 

 

 

 📡 Creating an API Account (API Method) 

 Setting up an API account through the API interface is a simple process that enhances workflow efficiency, especially when collaborating with team members across different locations. 

 

 

 Go to ‘Account & Management’ folder in Postman. 

 

 

 Select ‘Create a New API User’. 

 

 

 Customise the Request : Enter the name field (other fields are optional). 

 

 

 Click ‘Send’ (top-right corner). 

 

 

 Retrieve API Keys from the response. 

 

 

 Confirm API Account in Voila under "API Accounts." 

 

 

 

 Click to Play or Pause the Video 

 Getting a List of Couriers 

 To view the available couriers along with their names and details,  you can utilise this endpoint to access all pertinent information on how couriers are identified within the API and how to reference them later. 

 Follow these steps: 

 

 Expand the "Account & Management" folder, then select "List Couriers" from the left-hand menu. 

 Click "Send" to submit the request. 

 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. 

 

 

 Expand ‘Account & Management’. 

 

 

 Select ‘List Couriers’. 

 

 

 Click ‘Send’. 

 

 

 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: 

 

 

 Expand ‘Account & Management’. 

 

 

 Select ‘Get Auth Rules’. 

 

 

 Modify URL with the courier key:   {{api_url}}/API/couriers/v1/ENTER-YOUR-COURIER-KEY-HERE/register-auth-rules 

 

 

 Click ‘Send’. 

 

 

 View Required & Optional Parameters - the request-response contains the required and optional keys and their expected values, whether strings, 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: 

 

 Expand the "Account & Management" folder, then navigate to "Register Auth" in the left-hand menu. 

 Adjust the request URL, such as replacing the courier name with your desired choice. In this demonstration, we'll install DHL. 

 Customise the request data according to the courier's specific requirements. You can refer to the previous section if you need guidance on this. 

 Click the "Send" button at the screen's top left corner. 

 Review the request response to determine whether the installation was successful or unsuccessful. 

 To view the newly installed courier, proceed to Voila and select "API Accounts" from the left-hand menu. 

 In the API account where you installed the courier, click the "View Registered Auths" button. 

 You can confirm that DHL is listed in the installed courier's section, indicating a successful installation process. 

 

 📦 Installing a Courier via 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. 

 

 

 Expand ‘Account & Management’. 

 

 

 Select ‘Register Auth’. 

 

 

 Modify Request Data with the courier’s specific details. 

 

 

 Click ‘Send’. 

 

 

 Verify Response for success. 

 

 

 Check Installed Couriers in Voila under "API Accounts." 

 

 

 

 

 🤖 Creating Smart Rules 

 Smart shipping enables automated carrier selection based on predefined rules. 

 

 

 Access the Smart Shipping Interface . 

 

 

 Create Rule Groups & Smart Rules based on shipping parameters. 

 

 

 Optimise Costs & Delivery Speeds through automated courier selection. 

 

 

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

 

 You’re now set up with Postman and  API! 

  🚀 Happy shipping!