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 shipping account with Peoplevox.

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

    This

  1. Settingprocess upinvolves integrating a courier integrationservice onin Peoplevox, thatutilising pointsVoila as the intermediary. It consists of three main phases:

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

    Detailed Steps:

    Steps:Prerequisites:

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

    Integration Process:

    1. You needGenerate a PeoplevoxSecure account
      2. Key:
      • You need to have an api user and that user needs to have a token set up in Voila
      • GenerateUse a random key generator (e.g., Randomkeygen.com) to hoopcreate upa between Voilaunique and Peoplevoxsecure
      • YouPeoplevox needConfiguration: to
          use
        • Utilise thisthe generated key in two places:
          1. Setting upduring the courier inintegration Peoplevoxsetup within Peoplevox.
          2. Setting up the linking in Voila
      • ...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.

    How to SetSetting Up a Courier API in Peoplevox:

    To

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

      1. ClickNavigate to Integrations: In your Peoplevox dashboard, click on Integrations"Integrations."
      2. Click onAccess Carrier IntegrationsIntegrations: Select "Carrier Integrations" from the available options.
      3. Add a New Integration: Click on "Add NewNew" to begin the setup process.
      4. GiveName itYour Integration: Provide a descriptive name for the courier integration.
      5. TimeoutSet 999the Timeout: Enter "999" for the timeout value.
      6. Obtain the API KeyKey: isThe generatedAPI fromkey Voilawill ????be Samprovided callby itVoila.
      7. EndpointEnter the Endpoint: The endpoint URL is static and alwaysremains consistent.
      8. Specify the sameVersion Schema: Set the version schema to "2.0."
      9. VersionConfigure SchemaDocument needsTypes: to be 2.0
        • Document Type 1: Carrier Label
          • Name: documentReference 
          • Reference: Carrier Label 
          • Print Template: (needsSelect tothe becustomer's linked to apreferred shipping label of customers choice)template.
        • Document Type 2: Customs Documentation
          • Name: documentReference
          • Reference: Customs documentation
          • Print Template: LinkedSelect tothe customerscustomer's customs documentation template.
        • Document Type3:Type
            3:
          • Packing Slip Domestic
            •
            • Name: Packing Slip Domestic
            • ??Reference: Packing Slip Domestic
            • Print Template: (Please select the appropriate template or leave empty.)

      Setting up linking to Voila

       

       

       

       

      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 Sam / DC Shipping 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 PVX 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