# Connect Peoplevox to Starshipit
URL: https://support.starshipit.com/articles/360000934795-connect-peoplevox-to-starshipit
Canonical: https://support.starshipit.com/articles/360000934795-connect-peoplevox-to-starshipit
Markdown: https://support.starshipit.com/articles/360000934795-connect-peoplevox-to-starshipit.md
Updated: 2026-07-20

> For the complete documentation index, see [llms.txt](https://support.starshipit.com/llms.txt).

> Connect Peoplevox to Starshipit so orders can flow into Starshipit and shipping labels and tracking can flow back to Peoplevox.

Connect Peoplevox to Starshipit so allocated or despatched orders can be sent to Starshipit and labels and tracking numbers can be returned to Peoplevox.

![Flow of orders, labels, and tracking between Peoplevox and Starshipit](/uploads/articles/integrations/inventory-warehouse-retail-management/peoplevox-integration/image_360005317936.png)

:::important
Peoplevox may charge an additional subscription fee to enable its carrier integration module. Confirm access with Peoplevox before you begin.
:::

## Before you begin

You need:

- Admin access to Starshipit.
- Access to the **Integration** view in Peoplevox.
- Your Peoplevox client ID, username, password, and region if you want orders sent when stock is allocated.

## Add Peoplevox in Starshipit

1. In Starshipit, go to **Settings > Integrations**.
2. Click **Add a new integration**, then select **Peoplevox**.
3. Enter a display name for the integration.
4. Select the region used by your Peoplevox instance:
   - **Americas (US)**
   - **Asia Pacific (AP)**
   - **Europe (WMS)**
5. Map the Peoplevox sales-order attributes used for company name, building, phone number, currency code, and delivery instructions.
6. If required, map attributes 1–15 for HS code and country of manufacture.
7. Click **Save**.

## Receive orders when stock is allocated

This optional subscription sends orders to Starshipit earlier, giving you time to correct invalid addresses before despatch.

1. Enter the **Client ID**, **Username**, and **Password** used to access Peoplevox.
2. Set **Requested Delivery Date** to a recent date to prevent historical orders from importing.
3. Click **Save**.
4. Click **Test** and confirm the result is **Successful**.
5. Click **Subscribe**.

## Add Starshipit as a carrier integration in Peoplevox

1. In Peoplevox, switch to the **Integration** view.
2. Select **Carrier Integration**, then click **Add New**.
3. Enter `Starshipit` as the name.
4. Set **Date time format** to `dd/MM/yyyy hh:mm:ss`.
5. Set **Timeout (ms)** to `30000`.
6. Copy the **API key** and **Endpoint** from **Settings > Integrations > Peoplevox** in Starshipit.
7. Paste both values into Peoplevox.
8. Set **Tracking number format** to `{returns}/{outbound}`.
9. Click **Save**.

:::note
If Starshipit shows only a partial API key, go to **Settings > API** and click **Generate**, then return to the Peoplevox integration to copy the full key.
:::

## Verify the connection

Allocate or despatch a test order in Peoplevox. Confirm the order appears in Starshipit and that despatching it returns its label and tracking number to Peoplevox.

Next, [configure Peoplevox labels, couriers, and packages](/articles/90200000000501-configure-peoplevox-labels-couriers-and-packages).

## Configure Peoplevox settings

The integration settings control how Peoplevox data is mapped into Starshipit and how shipments are returned.

| Setting | What it does |
| --- | --- |
| **Display name** | Names this Peoplevox connection in Starshipit. |
| **Region** | Selects the Peoplevox region for the connection. |
| **Company name**, **Building**, **Phone number**, **Currency code**, **Tags**, **Duties amount**, **Delivery instructions**, **Contact name**, **HS code**, **Manufacture country**, and **MID code** | Map each Starshipit order or item field to a matching Peoplevox custom property or attribute. |
| **Client ID**, **Username**, **Password** | Credentials for the Peoplevox API. |
| **Filter date** | Limits the Peoplevox records considered for import from the selected date. |
| **Use staging URL** | Connects to the Peoplevox staging environment instead of production. |
| **Subscription ID** | Identifies the Peoplevox subscription used by the connection. |
| **Do not run rules on label print** | Prevents Starshipit rules from running again when a label is printed. |
| **Re-run cheapest carrier rules before label printing** | Re-evaluates the cheapest-carrier rule before printing. |
| **Import address line 2 to building** | Places Peoplevox address line 2 in Starshipit’s Building field. |
| **Import package type** | Imports the Peoplevox package type. |
| **Import item descriptions** | Imports item descriptions with the order lines. |
| **Package weights** / **Package details** | Choose whether Starshipit uses package weights or Peoplevox despatch-package dimensions and details. When package details are selected, choose the **Dimensions unit**. |
| **Consolidate shipment** | Combines Peoplevox packages into one Starshipit shipment when the despatch is complete. |
| **Writeback service type** | Sends the Starshipit service type back to Peoplevox. |

Save the settings, then despatch a test order to confirm the mappings and writeback behave as expected.
