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

Integrating your Voila Account on Peoplevox

Overview

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

Courier Integration Setup (Peoplevox & Voila) - 3 Phases:

This process involves integrating a courier service in Peoplevox, utilising Voila as the intermediary. It consists of three main phases:

  1. Peoplevox Courier Integration Setup: Configuring the courier connection within Peoplevox to point to Voila.
  2. Voila Configuration: Setting up the corresponding connection and processing rules within Voila.
  3. Key Linking: Establishing the secure communication link between Peoplevox and Voila.

Detailed Steps:

Prerequisites:

  • Access to a Peoplevox account.
  • An API user account within Peoplevox.
  • A corresponding API token is generated for the API user within Voila.

Integration Process:

  1. Generate a Secure Key:
    • Use a random key generator (e.g., Randomkeygen.com) to create a unique and secure key.
  2. Peoplevox Configuration:
    • Utilise the generated key during the courier integration setup within Peoplevox.
  3. Voila Configuration:
    • Enter the same generated key into the appropriate linking configuration section within Voila.

Note: Ensuring the same key is used in both Peoplevox and Voila is crucial for establishing a successful connection.

Setting Up a Courier API in Peoplevox:

To integrate a new courier service via API, follow these steps:

  1. Navigate to Integrations: In your Peoplevox dashboard, click on "Integrations."
  2. Access Carrier Integrations: Select "Carrier Integrations" from the available options.
  3. Add a New Integration: Click "Add New" to begin the setup process.
  4. Name Your Integration: Provide a descriptive name for the courier integration.
  5. Set the Timeout: Enter "999" for the timeout value.
  6. Obtain the API Key: The API key will be provided by Voila.
  7. Enter the Endpoint: The endpoint URL is static and remains consistent.
  8. Specify the Version Schema: Set the version schema to "2.0."
  9. Configure Document Types:
    • Document Type 1: Carrier Label
      • Name: documentReference
      • Reference: Carrier Label
      • Print Template: Select the customer's preferred shipping label template.
    • Document Type 2: Customs Documentation
      • Name: documentReference
      • Reference: Customs documentation
      • Print Template: Select the customer's customs documentation template.
    • Document Type 3: Packing Slip Domestic
      • Name: Packing Slip Domestic
      • Reference: Packing Slip Domestic
      • Print Template: (Please select the appropriate template or leave empty.)empty)

Setting up linking to Voila

POST Request to this endpoint: 

<a href="https://production.courierapi.co.uk" rel="noreferrer noopener" title="https://production.courierapi.co.uk/" target="_blank">https://production.courierapi.co.uk</a>/api/couriers/v1/third-parties/peoplevox/link-auth

headers: {'api-user' : 'YOUR API USER', 'api-token':'YOUR API USER TOKEN'},

and this is the JSON to post:

{
    "peoplevox_authorization_header" : "12345",
    "ship_from": {
            "name": "Fake Company",
            "phone": "01377 334140",
            "email": "[email protected]",
            "company_name": "Fake Company",
            "address_1": "Unit 99, Warfield Road",
            "address_2": "",
            "address_3": "",
            "city": "Fakefurt",
            "postcode": "YO250FK",
            "county": "East Yorkshire",
            "country_iso": "GB",
            "company_id": "03764419",
            "tax_id": "284256444",
            "eori_id": "GB284256444000",
            "ioss_number": null
        }
}

 

Setting up a Service Type: 

Services???? 1.38 Time... TestDC

Service Type, needs to match the smart shipping rule group name NOT SURE WHERE TO SET....

Provide Voila with :
Generate a random Pairing Key:
 
Populate the below with Live customer details
{
    "peoplevox_authorization_header" : "12345",
    "ship_from": {
            "name": "Fake Company",
            "phone": "01377 334140",
            "email": "[email protected]",
            "company_name": "Fake Company",
            "address_1": "Unit 99, Warfield Road",
            "address_2": "",
            "address_3": "",
            "city": "Fakefurt",
            "postcode": "YO250FK",
            "county": "East Yorkshire",
            "country_iso": "GB",
            "company_id": "03764419",
            "tax_id": "284256444",
            "eori_id": "GB284256444000",
            "ioss_number": null
        }
}
 
Advise Peoplevox the below and share the random pairing key via https://privatebin.despatchcloud.app
 
The endpoint to send requests to is:
https://production.courierapi.co.uk/api/couriers/v1/third-parties/peoplevox/create-label
The documentReference for the main label must be 'Carrier label'
The documentReference for customs must be 'Customs documentation'
 
from Peoplevox end must be using:
    "metadata": {
        "schemaVersion": "2.0",
        "platformVersion": "2.0",
        "documentBundleEndpointVersion": "1.1"
 
 
Service Codes from Peoplevox will point at the smart shipping Rule Group

Back to top