Integrating your Voila Account on Peoplevox

Overview

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

3 PHASES -

Setting up a courier integration on Peoplevox, that points to Voila

Setting up Voila

Steps:

You need a Peoplevox account

You need to have an api user and that user needs to have a token set up in Voila

Generate a random key to hoop up between Voila and Peoplevox
- Can use a random key generator: Randomkeygen.com

You need to use this key in two places:
1. Setting up the courier in Peoplevox
2. Setting up the linking in Voila

How to Set Up a Courier API in Peoplevox:

Click on Integrations

Click on Carrier Integrations

Click on Add New

Give it a name

Timeout 999

API Key is generated from Voila ???? Sam call it

Endpoint is static and always the same

Version Schema needs to be 2.0

Document Type 1:
- Name: documentReference
- Reference: Carrier Label
- Print Template: (needs to be linked to a shipping label of customers choice)

Document Type 2:
- Name: documentReference
- Reference: Customs documentation
- Print Template: Linked to customers customs documentation

Document Type3:
- Packing Slip Domestic
- Packing Slip Domestic
- ??

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