Courier Directory
Overview
Within Voila, we incorporate frequently used service presets for each courier. Our system continually updates these presets to ensure that our customers can readily access the latest and most popular services. We refer to these as "System Presets" within Voila. It eliminates the need to search for service codes or manually add them to your account. Your task is to select the desired presets, allowing your parcel to be sent using the chosen service.
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.
Courier Directory
To access the system presets, navigate to the "Courier Directory" page by selecting it from the menu on the left-hand side.
The Courier Directory page comprehensively lists all integrated couriers within Voila. To explore the system presets available for a particular courier, click on the respective courier's logo in the directory.
The primary objective of the Courier Directory is to enable you to utilise our pre-configured system presets and create custom presets tailored to each of your API accounts. These service presets are pre-defined codes designed to grant access to each courier's services.
For instance, selecting any courier and then clicking "Add Preset" will reveal a compilation of all the system presets corresponding to that specific courier's available services that you have set up previously or more that you can select.
Click to Play or Pause the Video
Custom Presets
Kindly consult our specialised page on custom presets to gain insights into this functionality.
How to Use Courier
Within Voila, we've developed a virtual environment known as the Playground. This feature enables you to initiate requests directly from our application, providing an experiential understanding of the processes involved when transmitting a request from your application to Voila.
It's important to note that utilising actual API credentials in the Playground may result in the courier charging for submitting requests.
What are Presets?
Presets are pre-configured settings for specific courier services. They allow you to send shipping requests with less information, making the process faster and easier.
Example: Royal Mail
-
Standard Service ID: In the image below, the request uses the standard Service ID "ROYALMAIL-CRL1-P". This ID includes information about the service level, service code, and service format. However, it requires you to specify the "Posting Location" in each request.
-
Creating a Custom Preset: To avoid specifying the Posting Location every time, you can create a custom preset. For example, a preset named "Royal Mail 24 Test" with the DC Service ID "RM24TEST" is created.
-
Using the Custom Preset: Now, instead of using "ROYALMAIL-CRL1-P" and specifying the Posting Location, you can simply use "RM24TEST" in your request. The system will automatically include the necessary information (Service Level, Service Code, Service Format, and Posting Location).
Choosing Your Approach
You have two options for sending shipping requests:
- Standard Service IDs: Use the standard format (e.g., "ROYALMAIL-CRL1-P") and include the Posting Location in each request.
- Custom Presets: Configure custom presets for frequently used services to avoid manually entering details like Posting Location.
Both options achieve the same result, but custom presets offer a more streamlined approach, reducing manual effort and potential errors.
Click to Play or Pause the Video
Understanding Courier Specific Preset Requirements
Different courier services have different requirements for setting up presets. The Courier Specifics Documentation can help you familiarise yourself with each courier's requirements.
Step 1: Consult the Courier Specifics Documentation
- Refer to the Courier Specifics Documentation for detailed information about each courier's preset requirements.
Step 2: Explore Courier Service Directories
- Access the "Courier Directory" to view specific requirements for each courier.
Examples:
-
DPD:
- Access the "DPD" service directory.
- You'll notice that the "Network Code" is the only consistent requirement.
- No additional JSON data is needed for DPD requests.
- Ensure you have the correct courier credentials for authorisation.
-
Hermes Corporate:
- Access the "Hermes Corporate" service directory.
- You'll find that this courier has no mandatory fields for presets.
-
Royal Mail:
- Access the "Royal Mail" service directory.
- You'll see essential elements like "Posting Location," "Service Level," "Service Format," and "Service Code."
- Tip: Create a custom preset to manage these elements automatically (as explained in the previous guide).
Key Takeaway: Each courier has unique preset requirements. By understanding these requirements and utilising custom presets where possible, you can streamline your shipping process and reduce manual effort. Always consult the Courier Specifics Documentation and explore the Courier Directory for detailed guidance.
Click to Play or Pause the Video