Shippit works seamlessly with Peoplevox to synchronise orders. This article explains how to set up your Peoplevox integration, configure it for your unique workflow, and get the most out of Peoplevox and Shippit.
Set up your Peoplevox integration
To get started with Peoplevox, you need to log in to your Shippit account to set up the integration, then complete setup in your Peoplevox account.
⚠️ Important: Before you begin, make sure you are logged in with a Peoplevox user account that has the Administrator role.
Setting up a dedicated user account in Peoplevox
This step is optional, but highly recommended. Creating a dedicated user in Peoplevox for the Shippit integration allows you to differentiate between actions performed by the integration, and actions performed by users.
Log in to your Peoplevox account.
Navigate to Users → Users, and click Add new.
In the Add new user dialog, use these details:
In the Email field, type your email address.
In the Display name field, type a name for your user. For example, Shippit.
In the Username field, type a name for your user. For example, Shippit.
In the Password field, type a password for your user, and confirm it in the Confirm password field.
In the Role field, select Integration.
Optional: In the Default printer field, select the default printer for the integration to use.
Take a note of the username and password you entered, and click Save to save your new user.
Setting up the integration in Shippit
When you have your dedicated user details, you can set up the integration in your Shippit account.
💡 Note: Before you start, take a note of your Peoplevox Client ID. It is shown in brackets in the top left hand corner of your Peoplevox account.
Log in to your Shippit store.
Open the drop down menu in the top right of your screen, and click Settings.
Click Integrations to go the integrations settings.
In the Select an Integration section, click Peoplevox.
Use the details you noted from your Peoplevox dedicated user account to complete these fields:
In the API Endpoint field, select the datacentre location for your Peoplevox installation. If you aren't sure which endpoint to use, contact Peoplevox support.
In the Client ID field, type your Peoplevox Client ID, which is available in your Peoplevox account.
In the API Username field, type the username of the dedicated Peoplevox user you created earlier.
In the API Password field, type the password of the dedicated Peoplevox user you created earlier.
Click Continue to complete your integration, and take a note of the endpoint and API key.
Setting up the carrier integration in Peoplevox
When you have set up the integration in Shippit, you can return to your Peoplevox account to add Shippit as a carrier integration.
⚠️ Important: As part of this procedure, you also need to set up the documents in Peoplevox for outbound shipping labels, customs or commercial invoices, and air way bills. Unfortunately, the integration does not support other documents, such as packing slips, invoices, returns labels, or dangerous goods declarations.
Log in to your Peoplevox account.
Navigate to Integrations → Carrier integration, and click Add new.
In the Create Carrier Integration dialog, use the details you noted from your Shippit account to complete these details:
In the Name field, type a name for your integration. For example, Shippit.
Leave the Date time format field as it is.
In the Timeout (ms) field, type 30000.
In the Api key field, paste the API key you noted down earlier.
In the Endpoint field, paste the endpoint you noted down earlier.
In the Tracking number format field, type {outbound}.
In the Request schema version, select 1.1.
Click Add new Document Types to add two new document types. Click Add. Use these details to set up the three document types:
Shipping Label, shipping_label, [None]
Customs Invoice, customs_invoice, [None]
Air Way Bill, awb_archive, [None]
Click Save to save the Shippit carrier integration.
Set up integration templates
When you have the carrier integration set up, you can set up the integration templates for carriers and service types. You can also use this procedure to synchronise goods descriptions from item names in orders.
It is also possible to set up tariff codes to synchronise from Peoplevox to Shippit. However, because these aren't native fields in Peoplevox, you need to set them up as a custom field. When you have your tariff codes saved as an item-level custom field in People, Shippit can pull that field as the tariff code for the item.
💡 Note: When an order has been synchronised into Shippit, none of the changes made against the same order in PeopleVox automatically updates Shippit.
Setting up integration templates in Peoplevox
Log in to your Peoplevox account.
Navigate to Integrations → Integration templates.
Locate Carriers in the list, select it, and click Configure.
Navigate to the Import tab, and edit the field names to read:
Name *: Name
Reference: Reference
Click Save to save your changes.
Locate Service Types in the list, select it, and click Configure.
Navigate to the Export tab, and edit the field names to read:
Carrier *: Carrier Name
Name: Service Type
Code *: Service Code
Click Save to save your changes.
Shipping options
You can configure shipping options in Shippit so that they more accurately match your Peoplevox settings. These settings allow you to select which Peoplevox shipping method matches a specific service or class in Shippit. The tracking information for your orders are passed back to Peoplevox when the label is generated in Shippit.
If you offer free shipping, you can manage your shipping costs by identifying the specific service or service class that you would like the order to be transacted through.
Changing shipping options
Log in to your Shippit store.
Navigate to Settings → Integrations.
In the Peoplevox integration settings section, navigate to the Orders tab.
In the Shipping Method Mappings section, for each Peoplevox shipping method in the left column, select the matching Shippit service type. If you don't want a location to map to a Shippit store, select Skip in the right column. Orders created by skipped locations are shown in your order sync history, but are not shown on the New Orders page. If you do not want Peoplevox orders of a specific type to go through to Shippit at all, select Don't send to Shippit.
Click Update to save your changes.
Site options
You can configure your site settings in Shippit so that orders and labels generated in Peoplevox are sent to the correct Shippit account.
Changing site options
Log in to your Shippit store.
Navigate to Settings → Integrations.
In the Peoplevox integration settings section, navigate to the Locations tab.
In the Peoplevox Site Mappings section, for each Shippit store, select the corresponding Peoplevox site or sites. The selected sites are shown beneath the drop-down box. Click x to remove sites.
Click Update to save your changes.
Order packaging options
You can configure your packaging settings in Shippit so that orders received from Peoplevox are processed as either items and parcels, or as items only.
When orders are sent to Shippit from Peoplevox, it is assumed that all weights are in kilograms, and dimensions are in metres. However, if the unit type is explicitly specified on the product or SKU, Shippit converts the dimensions in kilograms and metres for you.
Changing packaging options
Log in to your Shippit store.
Navigate to Settings → Integrations.
In the Peoplevox integration settings section, navigate to the Orders tab.
In the Order Packaging Mode section, select Items and parcels to receive orders as both items and parcels, or select Items Only to have all orders treated in Shippit as items.
Click Update to save your changes.
Pallet options
You can configure your packaging settings in Shippit so that orders received from Peoplevox are processed as pallets, if they meet pre-defined size criteria. When orders containing parcels that are larger than the size you set are synchronised to Shippit from Peoplevox, Shippit handles them as a pallet instead of a parcel.
Changing pallet options
Log in to your Shippit store.
Navigate to Settings → Integrations.
In the Peoplevox integration settings section, set the Sync parcels as pallets field to Yes.
In the Pallet detection section, set the minimum height, width, and depth for a parcel to be considered a pallet.
Click Update to save your changes.
Use native carrier tracking IDs
By default, Shippit passes the Shippit order tracking number back to Peoplevox for tracking purposes. You can use this tracking number to find tracking status changes on the Shippit tracking page. You can change this behaviour to use the carrier's native tracking ID instead of the Shippit ID. This is especially useful if you sell on a marketplace such as Amazon, which requires carrier tracking IDs to maintain listing validation.
Using native carrier tracking IDs
Log in to your Shippit store.
Navigate to Settings → Integrations.
In the Peoplevox integration settings section, navigate to the Orders tab.
In the Tracking ID section, select Courier tracking ID.
Click Update to save your changes.
International shipping
You can use your Peoplevox account to send cross-border shipments with international carriers you have turned on in your Shippit account. For more information about shipping internationally with Shippit, see the international shipping collection.
To start shipping internationally, you need to set up additional order item attributes in your Shippit account. These attributes are not native to Peoplevox, so Shippit uses custom order attributes to pass a range of customs and tariff information, including country codes, duties and taxes information, HS codes, manufacturer ID (MID) codes, and dangerous goods information. For more information about the various codes used for international shipping, see the duties and taxes article.
⚠️ IMPORTANT: Depending on your configuration, you might be able to include tariff or HS codes to inventory items directly in your Peoplevox account. If you have this setting configured, you can't add tariff or HS codes using this method.
There are two ways of using custom order attributes to pass customs information to Shippit from your Peoplevox account. Which one you use depends on what kind of information you need to send.
If you need to send tariff or HS codes and MID codes, you can map these individual codes to different custom attributes, and add this information to the inventory item in your Peoplevox account.
If you need to send a range of different customs information to Shippit, including duties amounts, incoterms, and tax ID information, you can map this to a single customs attribute, and declare it in your Peoplevox sales orders as a comma-separated list.
Configuring tariff and MID code attributes in your Shippit account
Log in to your Shippit store.
Navigate to Settings → Integrations.
In the Peoplevox integration settings section, navigate to the Orders tab.
In the Order items attribute mappings section, for each attribute, select an Order Item Attribute. Take a note of which attribute number you have assigned to each code. For example, you might set Tariff Code to Order Item Attribute 1, and Manufacturer ID code to Order Item Attribute 2.
Click Update to save your changes.
Setting tariff and MID code attributes on inventory items in your Peoplevox account
Log in to your Peoplevox account.
Navigate to Catalogue → Item types, select the product you want to edit, and click View.
In the Attributes tab, click Edit.
Type the appropriate code in the corresponding Attribute field that you mapped in your Shippit account. For example, if you set the Tariff Code to Order Item Attribute 1, type the tariff code for this product in the text box for Attribute 1.
Click Save to save the inventory item attributes.
Setting the customs attribute in your Shippit account
Log in to your Shippit store.
Navigate to Settings → Integrations.
In the Peoplevox integration settings section, navigate to the Orders tab.
In the Order attribute mappings section, for the Customs attribute, select an unused Order Item Attribute. Take a note of which attribute number you have assigned.
Click Update to save your changes.
Setting attributes on individual orders in your Peoplevox account
Log in to your Peoplevox account.
Navigate to Outbound Goods → Sales orders, and click Add New.
Complete the sales order as usual.
Compose the customs information string that includes all the customs information you need to pass to Shippit as comma-separated list, using the information in the table in this section. It doesn't matter in which order you declare the attributes. If you don't need a particular attribute, you can ignore it.
In the Attributes section, locate the Attribute field that you mapped in your Shippit account. For example, if you set Customs to Order Item Attribute 1, type the customs information string in the text box for Attribute 1.
Click Save to save your sales order.
To construct the customs information string for your customs attributes, use the information in this table. It doesn't matter in which order you declare the attributes. If you don't need a particular attribute, you can ignore it. An example customs information string might look like this:
shippit_customs_export_reason=commercial_purpose_sale,shippit_customs_incoterm=DDP,shippit_customs_tax_id_type=IOSS,shippit_customs_tax_id_country_code=GB,shippit_customs_tax_id_number=1234,shippit_duties_amount=123.45,shippit_customs_recipient_id=R100200RN,shippit_customs_receiver_freight_charge_amount=25.06
Attribute | Description | Example |
| The reason for exporting these goods. For a complete list of valid values, see the developer centre. |
|
| The incoterm to use for the order. For a complete list of valid values, see the developer centre. |
|
| Your tax ID type. This is passed to the carrier for the purpose of customs clearance. For a complete list of valid values, see the developer centre. |
|
| The two letter code of issuing country of the tax ID number. For a complete list of valid values, see the IBAN site. |
|
| The tax ID number that is declared against this order. |
|
| The customs duty payable on the order |
|
| A free text field to provide a identification number for a recipient. For example, a citizen identification number or passport number.
|
|
| The amount charged to the receiver for freight services. This represents the cost that the receiver is responsible for paying as part of the freight or shipping charges. |
|
Troubleshooting
This section contains information about some common issues you might encounter with your Peoplevox integration. If you can't find an answer to your question here, contact [email protected] for assistance.
Orders with multiple packages are creating multiple orders in Shippit
For Peoplevox integrations set up before 24 May 2024, orders with multiple packages resulted in multiple orders in Shippit. This behaviour has been deprecated, and orders with multiple packages are now shown in Shippit in a single order for shipping. If you are still experiencing the older behaviour, talk to Shippit support to be upgraded.
Peoplevox shipping methods or locations are not showing in Shippit integration settings
This can happen if your Peoplevox integration templates are not set up properly. Check that you have specified the field names properly, are specifying them in the Export tab, have spelled everything correctly, and used the correct case for case-sensitive fields.