# 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](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) 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="/files/Ko5xebHQwSWI3Z0kGxQs" 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:\
![](/files/JgGoLFznBZ9M4eRkXXvs)
{% 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](/product-documentation/connectors-and-instances/patchworks-connectors/descartes-peoplevox-prebuilt-connector/the-peoplevox-setdata-script.md#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](/product-documentation/process-flows/building-process-flows/process-flow-shapes/standard-shapes/connector-shape.md). However, some specific settings are required for this shape, as detailed below.

### setData script

If you [build a process flow](/product-documentation/process-flows/building-process-flows.md) 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](/product-documentation/connectors-and-instances/patchworks-connectors/descartes-peoplevox-prebuilt-connector/the-peoplevox-setdata-script/using-the-peoplevox-setdata-script-in-process-flows.md).

### Formatting script

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/descartes-peoplevox-prebuilt-connector.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.