API Documentation

This page provides a complete guide to integrating with Voila’s API using GET and POST methods. Whether you're retrieving data or submitting it, the documentation offers step-by-step instructions, endpoint explanations, and practical code examples to streamline your development process. Designed for both new and experienced developers, it covers everything from initial setup to interacting with courier-specific fields. Navigate easily between sections to explore general API functionality and individual courier requirements, ensuring smooth and effective implementation. Voila’s support team is also on hand to assist whenever needed.

This documentation provides a comprehensive overview of all features and functionalities available on the API Accounts page. It covers the process of creating a new API account, deactivating an existing one when necessary, and managing authentication details, including courier credentials. Additionally, it offers a detailed exploration of the Keys & Tokens, View Shipments, and Actions sections.

API Accounts

This guide will demonstrate the process of producing and comprehending a report within the API Reports page of the Voila.

API Reports Page

This documentation will guide you through effectively utilising this page and its accompanying features. This guide will cover essential tasks such as conducting searches within the requests, interpreting log files, and comprehending request particulars like response codes.

API Request Logs

This guide will delve into the significance of Voila Tracking Statuses, acquaint you with the Events Map, and reference the Mapped Events for each courier.

How Tracking API Works

Get Support

Postman Docs 

Playground

Changelog 

Our Website 

A series of short, practical videos designed to help you get the most out of Voila. Whether you're just getting started or looking to sharpen your skills, these walkthroughs will guide you through key features, best practices, and real-world use cases - so you can work smarter, faster, and more confidently.

Video Walkthroughs

Learn how to use Voila’s Hosted Pages feature to streamline your shipping workflow without the need for custom development. In this video, we’ll show you how to create and manage webhooks tied to hosted shipping events - like shipment creation, tracking, cancellation, and failures - so you can automate updates, improve visibility, and respond quickly to key delivery events.

Hosted Pages

The Playground serves as a simulation platform for label requests, aiding in understanding label creation logic and sending requests to Voila. It also accommodates other courier label submissions and real API credential usage (which can incur charges) while allowing label modification and validation through the API Dashboard or Shipment page.

Creating Shipping Labels in Voila

Watch the full video to learn how presets can streamline your shipping process and keep your operations consistent across your team.

Creating Presets in Voila

Welcome to the New Feature Documentation for Voila. This page provides detailed, up-to-date technical guides on the latest features, enhancements, and improvements to help you get the most out of our platform.

New Features

This document provides technical guidance on generating separate shipping labels for each parcel using the separate_parcel_labels parameter. By enabling this feature, each requested parcel receives its own individual label, simplifying logistics and improving shipment tracking.

Generating Separate Labels for Each Parcel

Learn how to install, configure, and operate Voila Desktop with step-by-step instructions, folder structure explanations, and practical usage tips. Whether you're a new user or managing a warehouse with frequent dispatches, this guide ensures you get the most out of Voila’s streamlined labelling solution.

Voila Desktop User Guide

The Hosted Pages feature in Voila offers a visual interface for functionalities traditionally managed through API calls. It simplifies integration by allowing users to generate invitation links, apply bespoke branding, and configure courier installations effortlessly. This guide provides a detailed explanation of each section within Hosted Pages, offering step-by-step instructions to maximise your platform's capabilities.

Hosted Pages in Voila

Say hello to the Voila Chatbot, your intelligent, lightning fast AI assistant designed to transform customer interactions. With seamless website integration, instant responses, and effortless training, it’s the chatbot that just gets it - right out of the box.

The Voila AI Chatbot That Works Like Magic ✨

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

Getting Started with Voila

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.

Standard Mode

Advanced Mode

Manage and customize your account settings.

Voila Account & Help

My Account is the hub for overseeing your Voila account. This section lets you access and review your account particulars and comprehensive billing data.

My Account

This documentation will elucidate the practical utility of this page and provide a comprehensive breakdown of its various sections. Finally, we will acquaint you with the Tracking Dashboard, elucidating how to effectively enable and harness its tracking capabilities.

Voila Dashboard

Welcome to the Voila Resource Hub – your go-to destination for mastering the Voila system. Access clear documentation, step-by-step video tutorials, and an interactive Playground to test label requests safely. Whether you're exploring the API or refining your workflow, you'll find the tools and guidance you need. Plus, our dedicated support team is always on hand to assist when you need help.

Help & Documentation

This document will guide you on how to contact support and create a ticket within our systems. It aims to assist you if you need help or have any questions.

Contacting Support

Access courier setup examples and add courier services effortlessly.

Courier Directory

This documentation will provide you with insight into the Courier Directory segment. Here, you can review the available system presets for a particular courier. Additionally, we will guide you through adding a courier service to Voila and creating your custom presets. Finally, we'll walk you through the steps of utilising the courier presets when initiating a shipment request.

Selecting a preferred courier service will automatically assign your parcel to the corresponding option. This guide will walk you through adding a courier service to Voila, focusing on the Courier Directory, where you can easily access and configure system presets for any courier.

How to Add a Courier Service

This document showcases the extensive range of courier integrations Voila offers. These integrations are designed to optimise your shipping processes and enhance your logistical efficiency.

Supported Courier Integrations

Courier Setups

This document provides a step-by-step guide to integration with Voila.

AJP Couriers Integration with Voila

This document provides a step-by-step guide to integration with Voila. 

AKM Global Courier Integration with Voila

AKM Global Solutions Courier Integration with Voila

This document provides a step-by-step guide to integration with Voila. 
 

AltLogic Courier Integration with Voila

Amazon Courier Integration with Voila

Amazon Shipping Central Courier Integration with Voila

Amazon Shipping France Courier Integration with Voila

Amazon Shipping Italy Courier Integration with Voila

Amazon Shipping Spain Courier Integration with Voila

APC Courier Integration with Voila

APG Global Courier Integration with Voila

This document provides a step-by-step guide to integration with Voila.  

Arrow XL Courier Integration with Voila

Asendia Courier Integration with Voila

B2C Europe (MAERSK) Courier Integration with Voila

Barcode Logistics Courier Integration with Voila

Bird System Courier Integration with Voila

BJS Home Delivery Courier Integration with Voila

Caribou Courier Integration with Voila

Chronopost Courier Integration with Voila

CitySprint Courier Integration with Voila

Colis Prive Courier Integration with Voila

Coll8 Logistics Courier Integration with Voila

Collect Plus Courier Integration with Voila

Correos Courier Integration with Voila

CR Transport Courier Integration with Voila

CSM Courier Integration with Voila

DaiPost Courier Integration with Voila

Deliver 360 Courier Integration with Voila

Delnext Courier Integration with Voila

Despatch Cloud Courier Integration with Voila

Deutsche Post Courier Integration with Voila

DG International Courier Integration with Voila

DHL eCommerce Courier Integration with Voila

DHL Express Courier Integration with Voila

DHL Parcel Germany Courier Integration with Voila

DHLParcel Netherlands Courier Integration with Voila

DHL Parcel Spain Courier Integration with Voila

DHLParcelUK Courier Integration with Voila

DHLPoland Courier Integration with Voila

DHL Warenpost Courier Integration with Voila

DHL Parcel UK Cloud Courier Integration with Voila

DPD Courier Integration with Voila

DPD Austria Courier Integration with Voila

DPD C2C Courier Integration with Voila

DPD Germany Courier Integration with Voila

DPD Ireland Courier Integration with Voila

DPD Local Courier Integration with Voila

DPD Netherlands Courier Integration with Voila

Dtt Deliveries Ltd Courier Integration with Voila

DX Courier Integration with Voila

DX Express Courier Integration with Voila

DX Freight Courier Integration with Voila

Envialia Courier Integration with Voila

ETA Distribution Courier Integration with Voila

Evri Courier Integration with Voila

Evri Corporate Courier Integration with Voila

Evri International Courier Integration with Voila

Exelot Courier Integration with Voila

ExFreight Courier Integration with Voila

Express Logistics Courier Integration with Voila

Expect Distribution Courier Integration with Voila

Fast Despatch Logistics Courier Integration with Voila

Fastway Courier Integration with Voila

FedEx Courier Integration with Voila

FedEx Cross Border Courier Integration with Voila

FedExV2 Courier Integration with Voila

FloStream Courier Integration with Voila

Fosseway Courier Integration with Voila

Furdeco Courier Integration with Voila

GFS Deliver Courier Integration with Voila

Global Corporate Logistics Ltd Courier Integration with Voila

GlobalE Courier Integration with Voila

GLS France Courier Integration with Voila

GLS Germany (DE) Courier Integration with Voila

GLS Ireland Courier Integration with Voila

GLS Netherlands (NL) Courier Integration with Voila

GLS Spain Courier Integration with Voila

Hancia Ltd Courier Integration with Voila

Hermes (EVRI) Courier Integration with Voila

Hermes Corporate (EVRI) Courier Integration with Voila

Hived Courier Integration with Voila

HubEurope Courier Integration with Voila

HubEurope Express Courier Integration with Voila

Huboo Shipping Courier Integration with Voila

Huxloe Courier Integration with Voila

Impact Express Courier Integration with Voila

InPost Courier Integration with Voila

International Bridge USPS Courier Integration with Voila

InXpress Belfast Courier Integration with Voila

Landmark Courier Integration with Voila

Low Cost Parcels Courier Integration with Voila

MH Courier Integration with Voila

MHI Courier Integration with Voila

Moov Parcel Courier Integration with Voila

Norsk Courier Integration with Voila

Now Fulfilment Courier Integration with Voila

OnLogistics Courier Integration with Voila

OrangeDS Courier Integration with Voila

Paack Courier Integration with Voila

Pallet Track Courier Integration with Voila

Shipments & Smart Shipping

The Shipments page offers a powerful, centralised interface for managing all your shipping activities with precision and ease. Access key shipment details such as courier, tracking, and reference information at a glance, while also benefiting from advanced features like API request logs, shipment controls, and label management. With customisable views, intuitive filters, and multiple search options, you can tailor the experience to your operational needs. Whether you're tracking delivery performance, creating new shipments, or downloading detailed reports, the Shipments page puts you in full control of your logistics workflow.



Shipments with Voila

Voila's Smart Shipping lets you define rules for automatically selecting the best delivery service for each order. Set criteria like package size, weight, value, and destination, and Voila does the rest! This guide walks you through setting up these rules.

Streamline Your Shipping with Voila's Smart Shipping

Configure email settings and templates and view notification history.

Notifications & Webhooks

In this guide, we will walk you through creating notifications. We'll introduce you to the options on the Notifications page and demonstrate how to manage and edit your notifications effectively.

Notifications

Welcome to the "Customer Notifications History" page, your central hub for tracking the status of notifications (emails) sent to customers. Here, you can view a comprehensive list of notifications, including sent, failed, cancelled, and pending messages, and take action accordingly. Explore options to check the details of past communications and cancel pending notifications.

This guide will help you make the most of these features and understand the intricacies of Notification details within Voila.

History

This documentation provides a comprehensive guide to configuring email settings in your Voila account, explicitly focusing on integration with MailGun. You will learn how to access the Email Settings section, create a new account, fill in account details, including the MailGun API Key, Domain, and API Base URL, and retrieve these MailGun-specific values from your MailGun account. Following these steps will ensure the successful configuration of your Voila Email Settings, enabling efficient email notification delivery through MailGun.

Email Settings

This document is a comprehensive guide to the suite of tools for crafting bespoke email templates. We'll walk you through creating an email template and demonstrate how to incorporate text, images, GIFs, HTML code, and more.

Email Templates

Web applications communicate through API calls, where requests yield responses, and webhooks serve as automatic event triggers that promptly relay information. Unlike API calls requiring periodic data polling, webhooks provide real-time event notifications. This document will guide you in creating and utilising webhooks within Voila and provide an overview of the Webhooks page's features.

Webhook

This directory contains documents that will help you set up features within Voila.

Knowledge Base

Voila empowers users with the capability to validate both domestic and international addresses before generating labels. This functionality mitigates the risk of failed deliveries stemming from inaccurate address information. As part of our commitment to enhancing delivery services, we are pleased to provide this feature to all our users at no cost.

This documentation elucidates the utilisation of this valuable feature and expounds upon the techniques employed by the Intelligent Address Formatter.

How Intelligent Address Formatting Works

Simplify your international shipping by electronically submitting customs documents after creating your shipping label. With FedEx Electronic Trade Documents, you can streamline customs processing and avoid manual paperwork.

FedEx Electronic Trade Documents Upload

Integrating your operational systems with a shipping API service can provide you with easy access to real-time shipment tracking information. Voila can help you retrieve this information effortlessly. With a dedicated function, Voila lets you monitor shipments from their despatch initiation to their final delivery destination. This documentation explains how to configure and deploy this tracking feature successfully in your system.

Shipment Tracking Dashboard on Voila

This document provides step-by-step instructions for integrating your Voila account with Mintsoft.

Integrating Your Voila Account on Mintsoft

This document outlines how to enhance the printing of information on 6x4 thermal paper using API customisation. This is achieved by adjusting keys such as "label_size" and "generate_packing_slip" to include order details, item specifics, and quantities on a single packing slip.

Print More on 6x4: API Quick Guide

Following these step-by-step instructions, you'll successfully request and set up low-volume Royal Mail Tracking for your shipping operations.

Requesting Low-Volume Royal Mail Tracking on Voila

This document outlines the implications of the Windsor Framework on your shipping operations, the data required for creating compliant shipment labels, and the necessary steps to ensure continued compliance.

The Windsor Framework

This document provides step-by-step instructions for integrating your Voila account with Peoplevox.

Integrating your Voila Account on Peoplevox

Voila provides seamless tracking configuration for couriers, enabling real-time delivery updates and ensuring you stay informed about the status of your shipments. This guide outlines the steps required to configure tracking within the Voila interface, including additional details for couriers requiring specific credentials.

Configuring Tracking within the Voila GUI

Experiment with label creation in the Playground environment.

Creating Labels in Playground

This documentation will comprehensively illustrate the process of adjusting the label size and initiating the label request. Furthermore, we will address a selection of frequently asked questions about labels and their associated sizes.