Peoplevox connector
Use this connector to create Carriyo shipments as your warehouse despatches boxes in Peoplevox WMS. When all boxes for a despatch are packed and labels are ready, Carriyo returns the merged label PDF synchronously in the webhook response. Peoplevox prints it directly from the warehouse station, no separate label retrieval step required.
Capabilities
- Webhook-driven shipment creation. Each Peoplevox despatch package becomes a Carriyo shipment (or adds a parcel to an existing shipment for the same despatch and service type).
- Synchronous label return. When
totalPickedItemsequalstotalDespatchedItems, Carriyo confirms all shipments and polls for labels. It merges them with any commercial invoices and returns the PDF URLs in the webhook response undernewPrintRequests[].printTemplateUrl. - Multi-parcel grouping. Boxes for the same despatch and service type are added as additional parcels on the same shipment. If the same parcel reference appears under a different service type, it's removed from the previous shipment.
- Bundled-product explosion. When a Peoplevox item is a bundle
(
itemType.components[]), the components become individual parcel items.
Setup
Configure in the Carriyo Dashboard under Connectors → Peoplevox.
- Default Currency: fallback when Peoplevox omits or sends a placeholder.
- Carriers: Peoplevox service-type code to Carriyo carrier account.
- Locations: Peoplevox Site to Carriyo location.
- Custom Attribute Mapping: map Carriyo fields
(
dropoff.company_name,dropoff.contact_name,dropoff.contact_phone,references.alternate_reference, or any custom attribute) to Peoplevoxattribute1–attribute5.
After the first save, the connector displays a read-only
apiKey. Peoplevox must send it as Authorization: Bearer {apiKey} on every inbound webhook.
In Peoplevox, configure a Carrier Integration with date format
dd/MM/yyyy hh:mm:ss, timeout 30000 ms, and request schema
version 2.0. Set the document type to "Carrier Label" and tie
it to a "Carriyo 4x6" print template.
Data mapping
| Peoplevox | Carriyo |
|---|---|
salesOrder.salesOrderNumber | references.partner_order_reference |
{despatchNumber}-{serviceTypeCode} (sanitized to Code128B) | references.partner_shipment_reference |
customer.{name, phone, mobile, email} | dropoff.{contact_name, contact_phone, contact_email} (mobile preferred; converted to E.164) |
shippingAddress (UK → GB) | dropoff address fields |
requestedDeliveryDate (DD/MM/YYYY HH:mm:ss) | order_date |
itemType.itemCode | sku |
buyPrice / salePrice | cost / price |
countryOfOrigin | origin_country |
hazardous | dangerous_goods |
| Service type (via Carriers mapping) | carrier_account.carrier_id |
| Site (via Locations mapping) | pickup.partner_location_id |
Cross-references between the Peoplevox despatch and the Carriyo shipments are retained for 90 days.
Limits and cadence
- Cadence. Webhook-driven only: synchronous request / response. Peoplevox expects label URLs in the webhook response body.
- Schema version. Only Peoplevox request schema version
2.0is accepted. - Payment. Hard-coded to
PRE_PAID. COD is not supported. - Past-booked shipments. If Peoplevox re-sends a box for a
shipment already in
booked,shipped, or another non-editable state, Carriyo returns the existing label. It does not error. - No retry loop. Failures return
status: failto Peoplevox; the warehouse station retries on its side.