Welcome!
This guide is designed for PeopleVox Implementation Consultants. We offer an out of the box solution to integrating third parties into PeopleVox and wanted to introduce our PeopleVox integration as we're a bit different!
If you have any questions at all, you can contact us at [email protected]
Setup
Customers can set up all the integrations through our website. We are here to support throughout the process, and available on email at [email protected].
As part of the set-up process, they will need to set up a user in PeopleVox that we can use to interact with the Warehouse.
We also provide Integration templates for PeopleVox. These are in the format of CSV files that can be imported into the Integration Templates section of PeopleVox. These templates are also available in the relevant sections below.
It is important these templates are configured in PeopleVox to support both our importing and data subscriptions.
If the customer is looking for other integrations, we can build custom integrations into PeopleVox. The customer can contact us for a custom integration.
Management
As an out of the box integration provider. We enabled customers can manage their integrations in our website.
They can enable and disable Integrations.
They can also control whether Orders or Purchase Orders are synchronised to Test or Primary Sites for example.
Integrations / Sync's
We provide a number of Integrations and sync's into and out of PeopleVox.
Products
We support syncing products from Shopify into PeopleVox. This is done whenever products are created or updated in Shopify. Shopify should be treated as the source of truth for product information. We never delete products from the PeopleVox.
Products must have both a unique SKUs and Barcodes; it is on the customer to maintain these in Shopify.
The customer can validate thier products using Pimsical and will get an email about any product issues, by triggering product validation in our website.
Products are synchronised as a soon as Shopify notify us about the change.
Product enrichments are updated in PeopleVox, periodically when they are changed in Shopify, if the customer has enabled the sync on the website.
Template
Mappings
| PeopleVox Field | Shopify Field | Explainer |
|---|---|---|
| ItemCode | variant.sku | The SKU of the product variant in Shopify. |
| ExternalId | variant.id | The Shopify ID of the product variant. |
| Attribute1 | variant.id | The Shopify ID of the product variant. |
| Attribute2 | variant.product_id | The Shopify ID of the product. The parent of the product variant. |
| Attribute4 | product.productCategory.productTaxonomyNode.name | The product category of the parent product in Shopify. Part of product enrichments. |
| Attribute5 | product.product_type | The product type of the parent product in Shopify. |
| Name | product.title OR variant.title/sku - product.title | The product title if there aren't any variants. Or the variant title or SKU and the title of the product. |
| Barcode | variant.barcode | The product variant barcode. |
| Description | product.body_html | The product body for display on a website. |
| ItemGroup | product.title | The product title, which will be the overall title for all variants. |
| Weight | variant.weight | The weight of the product variant. |
| TaxCode | variant.tax_code | The tax code of the product variant. |
| WeightMeasure | variant.weight_unit | The units of weight of the product variant. |
| RetailPrice | variant.price | The product variants price. |
| Tags | product.tags | The tags of the parent product. |
| HSCode | inventory_items.harmonized_system_code | The harmonised system code of the parent product. Part of product enrichments. |
| CountryOfOrigin | inventory_items.country_code_of_origin | The country code of origin of the parent product. Part of product enrichments. |
Orders
We support syncing orders from Shopify into PeopleVox. This is done whenever orders are paid, updated or cancelled in Shopify. Shopify should be treated as the source of truth for order information. We never delete orders from the PeopleVox.
Orders are synchronised as a soon as Shopify notify us about the change.
Template
Mappings
Sale Order
| PeopleVox Field | Shopify Field | Explainer |
|---|---|---|
| SalesOrderNumber | order.name OR order.id | The Shopify # order number or Shopify order id |
| CustomerPurchaseOrderReferenceNumber | order.name OR order.id | The Shopify # order number or Shopify order id |
| ShippingAddressCompanyName | order.shipping_address.company | The company provided on the orders shipping address |
| ShippingAddressLine1 | order.shipping_address.address1 | The first line of the address provided on the orders shipping address |
| ShippingAddressLine2 | order.shipping_address.address2 | The second line of the address provided on the orders shipping address |
| ShippingAddressCity | order.shipping_address.city | The city provided on the orders shipping address |
| ShippingAddressRegion | order.shipping_address.province | The county provided on the orders shipping address |
| ShippingAddressPostcode | order.shipping_address.zip | The zip/postal code provided on the orders shipping address |
| ShippingAddressCountry | order.shipping_address.country | The country provided on the orders shipping address |
| InvoiceAddressCompanyName | order.billing_address.company | The company provided on the orders billing address |
| InvoiceAddressLine1 | order.billing_address.address1 | The first line of the address provided on the orders billing address |
| InvoiceAddressLine2 | order.billing_address.address2 | The second line of the address provided on the orders billing address |
| InvoiceAddressCity | order.billing_address.city | The city provided on the orders billing address |
| InvoiceAddressRegion | order.billing_address.province | The county provided on the orders billing address |
| InvoiceAddressPostcode | order.billing_address.zip | The zip/postal code provided on the orders billing address |
| InvoiceAddressCountry | order.billing_address.country | The country provided on the orders billing address |
| order.email | The email address provided with the order | |
| ContactName | order.customer.first_name AND order.customer.last_name | The customers first and last name |
| TotalSale | order.total_price | The total price of the order |
| Discount | order.total_discounts | The total amount of discounts applied to the order |
| TaxPaid | order.total_tax | The total tax value on the order |
| ShippingCost | order.total_shipping_price_set.shop_money.amount | The price of shipping |
| CreatedDate | order.created_at | The date the order was created |
| PaymentMethod | order.payment_gateway_names | The payment methods used combined with an ambersand |
| Currency | order.currency | The currency the order was placed in |
| ChannelName | order.source_name | Where the order was placed from |
| Site | 'TestSite' OR 'PrimarySite' | Which PeopleVox site to assign the order to, if the order is a test order in Shopify it will be sent to the TestSite. If the customer has set to use the TestSite we will send orders to only the TestSite. |
| RequestedDeliveryDate | order.created_at | The date the order was created |
| Status | 'Cancelled' OR '' | If the order was cancelled or empty |
| ServiceType | order.shipping_lines.[0].code | The code of the first shipping line used |
| Attribute1 | order.id | The Shopify id of the order |
| Attribute2 | storeID, | The Shopify admin url where the order came from e.g. store.myshopify.com |
| Attribute3 | order.tags | Any tags on the order |
| Attribute4 | order.note | Any notes on the order |
| Attribute5 | item.order.shipping_address.phone | Any shipping phone number |
Sale Order Items
| PeopleVox Field | Shopify Field | Explainer |
|---|---|---|
| SalesOrderNumber | order.name OR order.id | The Shopify # order number or Shopify order id |
| ItemCode | line.sku | The SKU of the line item |
| QuantityOrdered | line.quantity | The Quantity ordered of the line item |
| Line | line.id | The Shopify line-item id |
| Sequence | index | The position of the line item in the order |
| SalePrice | line.price | The price of the line |
| RequestedDeliveryDate | order.created_at | The date the order was created |
Despatches
We support syncing despatches from PeopleVox into Shopify. This is done whenever a despatch is created or tracking information is added. PeopleVox should be treated as the source of truth for despatch information. We will not fulfil any previously fully fulfilled lines in Shopify. An order can have multiple fulfilments.
We need the Carriers and Service Types to be set up to support tracking information. This is a manual process the customer will need to complete.
Despatches are synchronised as a soon as PeopleVox notify us about the change, this is usually 2 - 5 minutes.
Template
Mappings
| PeopleVox Field | Shopify Field | Explainer |
|---|---|---|
| N/A | location_id | The Shopify location configured by the customer in Pimsical |
| TrackingNumber | tracking_number | The tracking number provided on the despatch |
| Despatch.Carrier.Reference OR Despatch.Carrier.Name | tracking_company | The name of the carrier used to deliver the order |
| Despatch.ServiceType.Name OR Despatch.ServiceType.Code | N/A | The name of the service type used to deliver the order |
| Despatch.Picks.SalesOrder.SalesOrderNumber | N/A | The friendly order name/number |
| Despatch.Picks.SalesOrder.Attribute1 | order.id | The Shopify id for the order |
| Despatch.Picks.SalesOrder.Attribute2 | N/A | The Shopify store for the order |
| Despatch.DespatchNumber | N/A | The PeopleVox despatch number |
| DespatchItems.ItemType.ItemCode | line_items.sku | We look up the line items from Shopify to fulfil based on the SKUs from PeopleVox |
| DespatchItems.Quantity | line_items.quantity | We will fulfil the provided quantity. |
Inventory
We support syncing inventory from PeopleVox into Shopify. This is done whenever an inventory level changes. PeopleVox should be treated as the source of truth for inventory levels.
Inventory is synced as a soon as PeopleVox notify us about the change, this is usually 2 - 5 minutes.
Mappings
These fields are from the Item types.
| PeopleVox Field | Shopify Field | Explainer |
|---|---|---|
| N/A | location_id | The Shopify location configured by the customer in Pimsical |
| Attribute1 | variant.id | The Shopify id for the product variant |
| Available | inventory_level | The amount of inventory available for sale |
Purchase Orders
We support syncing Purchase Orders from Inventory Planner into PeopleVox. This is done once a day at 2pm UTC when the customer enables this integration. Inventory Planner should be treated as the source of truth for purchase orders. We never delete purchase orders from the PeopleVox.
Purchase orders must have SKUs that are already on Item types, it is on the customer to ensure the products exist.
We also synchronise Goods Received from PeopleVox into Inventory Planner. We will only receive SKUs that are on the purchase order. This is done as a soon as PeopleVox notify us about the change, this is usually 2 - 5 minutes.
We will also take any suppliers from the purchase orders and add them to the list of Suppliers in PeopleVox.
Template
Mappings
Purchase Orders
| PeopleVox Field | Inventory Planner Field | Explainer |
|---|---|---|
| PurchaseOrderNumber | order.reference/order.id | The Inventory Planner reference and id for the purchase order |
| Status | 'Cancelled' OR '' | If the purchase order has been Cancelled in Inventory Planner |
| Reference | order.id | The Inventory Planner reference for the purchase order |
| SupplierReference | order.source | The Inventory Planner source for the purchase order |
| RequestedDeliveryDate | order.created_date | The date the purchase order was created |
| SubmittedDate | order.created_date | The date the purchase order was created |
| ExpectedDeliveryDate | order.expected_date | The date the purchase order is expected |
| EndDate | order.received_date | The date the purchase order was received |
| Site | 'TestSite' OR 'PrimarySite' | If the customer has set to use the TestSite we will send orders to only the TestSite. |
Purchase Order Line Items
| PeopleVox Field | Inventory Planner Field | Explainer |
|---|---|---|
| PurchaseOrderNumber | order.reference/order.id | The Inventory Planner reference and id for the purchase order |
| ItemCode | line.sku | The SKU for the line item on the purchase order |
| Quantity | line.replenishment | The quantity of the item on the purchase order |
| Line | line.id | The Inventory Planner id for the line |
| Sequence | index | The position of the line |
| CostPrice | line.cost_price | The cost price of the line |
| ExpectedDeliveryDate | order.expected_date | The date the purchase order is expected |
| RequestedDeliveryDate | order.created_date | The date the purchase order was created |
Suppliers
| PeopleVox Field | Inventory Planner Field | Explainer |
|---|---|---|
| Name | order.source | The Inventory Planner source for the purchase order |
| Reference | order.source | The Inventory Planner source for the purchase order |
Goods Recieved
| PeopleVox Field | Inventory Planner Field | Explainer |
|---|---|---|
| Consignments.ConsignmentItemTypes.Consignment.PurchaseOrder.PurchaseOrderReference | order.id | The Inventory Planner id for the purchase order |
| Consignments.ConsignmentItemTypes.Quantity | items.quantity | The quantities recieved in PeopleVox |
| Consignments.ConsignmentItemTypes.ItemType.ItemCode | items | The SKU of the recieved items, we use this to look up the id of the line from Inventory Planner |