Descartes Peoplevox (prebuilt connector)

Description

Descartes Peoplevox is the Warehouse Management System for eCommerce businesses, online retailers and direct to consumer brands.

API documentation

API documentation for Peoplevox (used to build this connector) can be found via the link below:

https://peoplevox.help.descartesservices.com/peoplevox-knowledge-base/integrations/peoplevox-api-guide~7400049439868183793peoplevox.help.descartesservices.com

Authentication

When adding connector instances for Peoplevox, the following authentication methods are supported:

• SOAP request authentication method

SOAP request authentication

Required credentials

When a user chooses to add a connector instance using SOAP request authentication, the credentials below are prompted:

Credential	Required?	Notes
Username		The username that you enter to access the Peoplevox dashboard.
Client ID		Available from the Peoplevox dashboard.
Password		The password that you enter to access the Peoplevox dashboard.
Environment		This is the URL (without the https prefix) that you use to access Peoplevox. Typically this is wms.peoplevox.net.
Response authentication token key		Leave set to the default: //ns:Detail

Obtaining credentials

Client ID & Username

Step 1 In your browser, open the URL that you use to access the Peoplevox dashboard.

Step 2 Check the top right-hand corner of the dashboard - you'll see your client id followed by your username (the short form in brackets) - for example:

Having logged into Peoplevox, your client ID is also shown in the URL - for example:

Password

The password is the same password that you use to log into Peoplevox.

Required Additional setup

SetData script

Before using this connector as a target connection in process flows, you must create a setData script.

Having completed this setup, the Peoplevox connector is ready to use.

Using the Peoplevox connector in process flows

The Peoplevox connector is like any other Patchworks connector - it gets added to process flows via a connector shape. However, some specific settings are required for this shape, as detailed below.

setData script

If you build a process flow with Peoplevox as a target connection, you must add a custom script shape and apply the setData script immediately before the target connection shape.

For more information please see: Using the Peoplevox setData script in process flows.

Formatting script

If you pull data from Peoplevox (i.e. your process flow includes a connection shape configured with a Peoplevox GET endpoint), the payload is generated as XML data. If required, you can convert the XML payload to JSON using a conversion script.

For more information please see: Peoplevox XML to JSON conversion script.