# 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:

{% embed url="<https://peoplevox.help.descartesservices.com/peoplevox-knowledge-base/integrations/peoplevox-api-guide~7400049439868183793>" %}

## Authentication&#x20;

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

* [SOAP request authentication method](#soap-request-authentication)

### SOAP request authentication

{% tabs %}
{% tab title="Required credentials" %}
When a user chooses to [add a connector instance](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance) using **SOAP request authentication**, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th width="157" data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td>Username</td><td>true</td><td>The username that you enter to access the Peoplevox dashboard.</td></tr><tr><td>Client ID</td><td>true</td><td>Available from the Peoplevox dashboard.</td></tr><tr><td>Password</td><td>true</td><td>The password that you enter to access the Peoplevox dashboard.</td></tr><tr><td>Environment</td><td>true</td><td>This is the URL (without the https prefix) that you use to access Peoplevox. Typically this is <code>wms.peoplevox.net</code>.</td></tr><tr><td>Response authentication token key</td><td>true</td><td>Leave set to the default:<br><code>//ns:Detail</code></td></tr></tbody></table>
{% endtab %}

{% tab title="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:&#x20;

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2Fb0vuLTe6DerxjUvRYkRI%2Fpeoplevox%20client%20id%20and%20username.png?alt=media&#x26;token=4f46d486-71fa-4865-a4f4-fd26a2373788" alt="" width="375"><figcaption></figcaption></figure></div>

{% hint style="info" %}
Having logged into Peoplevox, your **client ID** is also shown in the URL - for example:\
![](https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FXRtbmbtzLDrEiSFKwkwJ%2Fpeoplevox%20client%20id%20b.png?alt=media\&token=52ec7158-65b5-408b-bc80-764b3d53ee44)
{% endhint %}

#### Password

The password is the same password that you use to log into Peoplevox. &#x20;
{% endtab %}
{% endtabs %}

## Required Additional setup

### SetData script

Before using this connector as a [target connection in process flows](#using-the-peoplevox-connector-in-process-flows), you must [create a setData script](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/the-peoplevox-setdata-script#stage-3-create-a-setdata-script).

Having completed this setup, the Peoplevox connector is ready to use.&#x20;

## 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](https://doc.wearepatchworks.com/product-documentation/process-flows/building-process-flows/process-flow-shapes/standard-shapes/connector-shape). However, some specific settings are required for this shape, as detailed below.

### setData script

If you [build a process flow](https://doc.wearepatchworks.com/product-documentation/process-flows/building-process-flows) with Peoplevox as a **target** connection, you must add a custom script shape and apply the **setData** script i**mmediately before the target connection shape**.&#x20;

For more information please see: [Using the Peoplevox setData script in process flows](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/descartes-peoplevox-prebuilt-connector/the-peoplevox-setdata-script/using-the-peoplevox-setdata-script-in-process-flows).

### Formatting script

If you pull data from Peoplevox (i.e. your [process flow](https://doc.wearepatchworks.com/product-documentation/process-flows/about-process-flows) includes a [connection shape](https://doc.wearepatchworks.com/product-documentation/process-flows/building-process-flows/process-flow-shapes/standard-shapes/connector-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](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/descartes-peoplevox-prebuilt-connector/peoplevox-xml-to-json-conversion-script).