Set up: Peoplevox Integration

9 June 2021

Setting up your eCommerce Hub – Peoplevox API Integration
 

How will orders be imported to eCommerce Hub 
Once you Despatch an order in Peoplevox, it will automatically import to eCommerce Hub 
eCommerce Hub Setup
You first need to configure eCommerce Hub to connect to your Peoplevox account. This part is very straightforward. 

1. Log into your eCommerce Hub account and from the menu bar on the side click Setup and Integrations
    
2. Click Add New Integration and then click the Add button for Peoplevox API.
    
   • If the Peoplevox API option is not present, please contact the support team.
3. Confirm the currency, weight, and dimension units you use, and if partial shipments should be allowed.
    
4. Click Create and a new page will open showing the integration credentials. Click on the field titled "Your API Key" to copy the key to your clipboard.
   • N.B. Keep this screen open as you will need some of this information for the next steps in Peoplevox.

 This concludes the ECommerce Hub side of the setup, you now need to go to Peoplevox to complete the process.


Peoplevox setup

1. In a new tab, log into your Peoplevox account and select Integration from the dropdown menu in the top right corner of the screen.
    
2. Go to the Carrier Integration tab. Click on Add New.
    
3. Fill in all the information:
   • Name - This is the name of the integration in PVX. i.e. ECommerce Hub.
   • Date time format - should be left at the default of <dd/MM/yyyy hh:mm:ss>
   • Timeout (ms) - the timeout limit for calls to ECommerce Hub, we recommend <20000>
   • API key - this is the API key generated in the steps above in the ECommerce Hub UI.
   • Endpoint -  This should be set to <https://data.scurri.co.uk/peoplevox-api/company_slug/document-bundles>
     • <company_slug> will be your specific company slug. If you do not have this, contact support and they will provide it for you.
   • Tracking number format - This should be set to <{outbound}>
   • Document Types - You should add 2:
     • 1 for 4x6 labels
     • 1 for A4 customs invoices for international orders 
     • These should each be assigned to the correct template for the page size.
4. Click Save. Peoplevox is now connected to your eCommerce Hub account.
    

When despatching an order, ensure you select the appropriate print templates for 4x6 labels and for A4 invoices for international orders.
When you despatch an order, PVX will send the order information to eCommerce Hub, eCommerce Hub will generate the label(s) and, if needed, the customs invoices and return these to PVX. PVX will then print these using the templates selected via the PVX Print Service.