Introduction
Data is imported to PVX using an integration template. The template defines the type of record being imported, as well as defining a mapping between the user’s column names and the standard PVX names for the fields on that record.
Examples of integration templates include carriers, sales orders and items. Some records are represented by more than one template, for example the sales order is defined by a header record and a collection of sales order item records. The header uses one template, and the item lines use another. In those scenarios, the header record must be imported first, so that it can be referenced on the lines. In the sales order example, the header defines the SalesOrderNumber which uniquely identifies the order. The subsequent lines then reference that SalesOrderNumber.
Each template is further divided into an “Import” and an “Export” template. The import template is used to map incoming CSV files onto the standard PVX record, and the export template is used to define the format of the CSV file produced by PVX when exporting data on the GetData API method. In some cases, the import and export templates may be identical, but in others, some data may only be available on an export (for example, inventory levels on the “Item types” template).
Note that the integration templates do not affect the PVX event subscription functionality in any way.
The templates must be configured before they can be referenced. This configuration process takes place in the PVX web app. To configure a template, the user defines their desired field mappings for that record type.
Key to Data Formats
String(x): A text string containing a maximum of x characters (including spaces).
Integer: A whole number.
Decimal: Contains a fraction expressed in up to two decimal places.
Date: Expressed in yyyy-MM-dd HH:mm:ss format (HH:mm:ss is optional).
Boolean: Normally TRUE or FALSE, or one of two possible values.
Note: Asterisks (*) in the tables below denote mandatory fields.
Carriers
Unique identifier: Name
Must be imported before Service types.
Import and export:
Reference |
Type |
Description |
Name * |
String(1000) |
The (unique) name of the carrier as it will appear within the app. Used as a handle on the carrier to assign services to it. |
Reference |
String(1000) |
External reference (optional). |
Customers
Unique identifier: Reference
Must be imported before Customer Addresses.
Import and export:
Reference |
Type |
Description |
Name * |
String(1000) |
Name. |
Reference |
String(1000) |
A unique reference to the customer; used as a handle to update it after creation and to link related records to it. |
FirstName |
String(1000) |
First name (optional). |
LastName |
String(1000) |
Last name (optional). |
Phone |
String(1000) |
Phone number (optional). |
Mobile |
String(1000) |
Mobile number (optional). |
String(1000) |
Email address (optional). |
|
CreditLimit |
Decimal |
Credit limit (optional). |
CreditStatus |
Boolean |
Credit status (optional, false by default). |
Wholesaler |
Boolean |
Wholesaler flag (optional, false by default). |
Customer Addresses
Unique identifier: AddressReference
Import:
Requires: Customers to be imported first.
Reference |
Type |
Description |
CustomerName * |
String(1000) |
This refers to the customer external reference on the template above. |
AddressLine1 |
String(1000) |
Line 1 (optional). |
AddressLine2 |
String(1000) |
Line 2 (optional). |
AddressCity |
String(1000) |
City (optional). |
AddressRegion |
String(1000) |
Region (optional). |
AddressPostcode |
String(1000) |
Post code (optional). |
AddressCountry |
String(1000) |
Country (optional). |
AddressReference |
String(1000) |
Reference (optional). |
Export:
Reference |
Type |
Description |
CustomerName |
String(1000) |
Customer name. |
CustomerReference |
String(1000) |
Customer external reference. |
AddressLine1 |
String(1000) |
Line 1 (optional). |
AddressLine2 |
String(1000) |
Line 2 (optional). |
AddressCity |
String(1000) |
City (optional). |
AddressRegion |
String(1000) |
Region (optional). |
AddressPostcode |
String(1000) |
Post code (optional). |
AddressCountry |
String(1000) |
Country (optional). |
AddressReference |
String(1000) |
Reference (optional). |
Despatch Packages
Note: This template is only available to export information because despatches are created inside PVX. We recommend that you use the DespatchPackageDespatched event subscription or the "Despatched items by package" report instead.
Field |
Data Format |
Weight |
Decimal |
Height |
Decimal |
Width |
Decimal |
Depth |
Decimal |
TrackingNumber |
String(1000) |
DespatchNumber |
String(1000) |
PackageTypeName |
String(1000) |
PackageTypeWeight |
Decimal |
PackageTypeHeight |
Decimal |
PackageTypeWidth |
Decimal |
PackageTypeDepth |
Decimal |
Despatches
Note: This template is only available to export information because despatches are created inside PVX. We recommend that you use the DespatchPackageDespatched event subscription or the "Despatch summary" report instead.
Field |
Data Format |
Description |
DespatchNumber |
String(1000) |
|
TrackingNumber |
String(1000) |
|
NumberOfPackages |
Integer |
|
StartTimestamp |
Date |
|
EndTimestamp |
Date |
|
TrackingTimestamp |
Date |
|
LoadReference |
String(1000) |
If using Despatch by load. |
SalesOrderNumber |
String(1000) |
Item Types
Item Templates
This group of related templates is used to import/export various details concerning items:
Item types: The details of the items themselves.
Item type groups: The structure of the index in which items are organised.
Item type units: The units of measure and quantities for each item (if used in PVX).
Item type suppliers: The supplier(s) for each item and optional data on minimum order quantities and lead times.
Item type kittings: Defines each parent/child combination in kits used in the WMS.
Most of these templates only import their data successfully if another template is imported first:
Most of the templates require item types to be imported first.
Item type suppliers requires both item types and the suppliers templates to be imported first.
Only item type groups is independent. However, if this template is not imported, then the ItemGroup field in the item types template will create new groups in PVX if it is populated, so we recommend importing item type groups first if you want to use an index to organise your items in PVX.
Unique identifier: ItemCode
Import:
References, but does not require: Item type groups.
Reference |
Type |
Description |
ItemCode * |
String(1000) |
Item code, a unique identifier for the item. |
ExternalId |
String(1000) |
Alternative handle for an item used to specify which items to update and what ItemCode to apply. |
Name |
String(1000) |
The name displayed to users. Typically, this is the name of the product as it would appear to customers (optional). |
Barcode |
String(1000) |
The barcode of the item, this must be unique and will default to the ItemCode if not provided. |
MinimumPickLocationQuantity |
Int |
The minimum desired quantity of the item across all pick locations in a warehouse. Used by the replenishment function to determine the point at which a replenishment action should be created. |
DefaultReplenishmentQuantity |
Int |
The default quantity to be replenished (moved from bulk to pick) when the replenishment is triggered. |
Attribute1 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute2 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute3 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute4 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute5 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute6 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute7 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute8 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute9 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute10 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute11 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute12 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute13 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute14 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
Attribute15 |
String(1000) |
A generic attribute that can be used to hold string data (optional). |
DefaultSuppliersPartNumber |
String(1000) |
Suppliers part number (optional). |
Description |
String(1000) |
A longer description of the item displayed where space exists for additional information beyond the name and item code (optional). |
ItemGroup |
String(50) |
The name of the item group to which the item should belong. If a name is provided that does not exist, a new group is created with the specified name (optional). |
Weight |
Decimal |
Weight (optional). |
TaxCode |
String(1000) |
The name of the tax code to assign to the item. This is a lookup on the list of defined tax codes, so the tax code will need to be defined before it can be referenced here (optional). |
UnitOfMeasure |
String(10) |
Unit of measure (optional, EA by default) (see Units of Measure). |
DefaultEconomicOrderQuantity |
Int |
The best value purchase quantity. This is not used internally by the WMS but can be displayed on reports if provided (optional). |
DefaultLeadTime |
Int |
The delivery time (in calendar days). This is not used internally by the WMS but can be displayed on reports if provided (optional). |
HasSerialNumbers |
Boolean |
Indicates whether the item has serial numbers associated with it (optional, false by default). |
UseManufacturersSerialNumber |
Boolean |
(optional, false by default). |
ReorderPoint |
Int |
The inventory level at which the item needs reordering. This is not used internally by the WMS but can be displayed on reports if provided(optional). |
Traceability |
Boolean |
Traceability (optional, false by default). |
ShelfLife |
Date |
Date in “yyyy-MM-dd HH:mm:ss” format (optional). |
DefaultNumberItemsPerContainer |
Int |
The default quantity of this item that forms a container. This is not used internally by the WMS but can be displayed on reports if provided (optional). |
DefaultContainerType |
String(50) |
Default container type name. This is not used internally by the WMS but can be displayed on reports if provided (optional). |
DefaultNumberItemsPerOuterCase |
Int |
The default quantity of this item that forms an outer case. This is not used internally by the WMS but can be displayed on reports if provided (optional). |
DefaultNumberItemsPerInnerCase |
Int |
The default quantity of this item that forms an inner case. This is not used internally by the WMS but can be displayed on reports if provided (optional). |
BuyPrice |
Decimal |
The price at which the item is bought. Referenced by some reports in order to calculate cost prices where more detailed information is not available (optional). |
WholesalePrice |
Decimal |
Wholesale price. This is not used internally by the WMS but can be displayed on reports if provided (optional). |
RetailPrice |
Decimal |
Retail price. This is not used internally by the WMS but can be displayed on reports if provided (optional). |
WeightMeasure |
String(10) |
Weight measure symbol (optional) (see Units of Measure). |
Height |
Decimal |
Height (optional). |
Width |
Decimal |
Width (optional). |
Depth |
Decimal |
Depth (optional). |
DimensionMeasure |
String(10) |
Dimension measure symbol (optional) (see Units of Measure). |
Tags |
String(8000) |
A generic string field that can be used for searching within the web application (optional). |
HSCode |
String(1000) |
A field that can be used to hold the harmonized product code for the product, which can be communicated to carrier integrations if required for international goods declarations (optional). |
CountryOfOrigin |
String(1000) |
Can be used to indicate the source of the product. Typically, this would be the three-letter ISO code for the country in which the product originated but check with your carrier partner in what format they may want this data (optional). |
DryIce |
Boolean |
A flag to indicate whether the product consists of or contains dry ice. This may be used by some carrier partners when generating international goods declarations (optional). |
MedicalDryIce |
Boolean |
A flag to indicate whether the product consists of or contains medical-grade dry ice. This may be used by some carrier partners when generating international goods declarations (optional). |
Alcohol |
Boolean |
A flag to indicate whether the product consists of or contains alcohol. This may be used by some carrier partners when generating international goods declarations (optional). |
Hazardous |
Boolean |
A flag to indicate whether the product consists of or contains potentially dangerous substances. This may be used by some carrier partners when generating international goods declarations (optional). |
Export:
Reference |
Type |
Description |
ItemCode |
String(1000) |
Item code, a unique identifier for the item. |
ExternalID |
String(1000) |
Alternative handle for an item used to specify which items to update and what ItemCode to apply. |
Name |
String(1000) |
The name displayed to users; typically, this is the name of the product as it would appear to customers. |
Barcode |
String(1000) |
Barcode. |
MinimumPickLocationQuantity |
Int |
The minimum desired quantity of the item across all pick locations in a warehouse. Used by the replenishment function to determine the point at which a replenishment action should be created. |
DefaultReplenishmentQuantity |
Int |
The default quantity to be replenished (moved from bulk to pick) when the replenishment is triggered. |
Attribute1 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute2 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute3 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute4 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute5 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute6 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute7 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute8 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute9 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute10 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute11 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute12 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute13 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute14 |
String(1000) |
A generic attribute that can be used to hold string data. |
Attribute15 |
String(1000) |
A generic attribute that can be used to hold string data. |
DefaultSuppliersPartNumber |
String(1000) |
Suppliers part number. |
Description |
String(1000) |
A longer description of the item; displayed where space exists for additional information *beyond the name and item code). |
ItemGroup |
String(50) |
The name of the item group to which the item belongs. |
Weight |
Decimal |
Weight. |
TaxCode |
String(1000) |
The name of the tax code to which the item is assigned. |
UnitOfMeasure |
String(10) |
Unit of measure (EA by default) (see Units of Measure). |
DefaultEconomicOrderQuantity |
Int |
The best value purchase quantity. |
DefaultLeadTime |
Int |
The delivery time (in calendar days). |
HasSerialNumbers |
Boolean |
Indicates whether the item has serial numbers associated with it (false by default). |
UseManufacturersSerialNumber |
Boolean |
(false by default). |
ReorderPoint |
Int |
The inventory level at which the item needs reordering. |
Traceability |
Boolean |
Traceability (false by default). |
ShelfLife |
Date |
Date in “yyyy-MM-dd HH:mm:ss” format. |
DefaultNumberItemsPerContainer |
Int |
The default quantity of this item that forms a container. |
DefaultContainerType |
String(50) |
Default container type name. |
DefaultNumberItemsPerOuterCase |
Int |
The default quantity of this item that forms an outer case. |
DefaultNumberItemsPerInnerCase |
Int |
The default quantity of this item that forms an inner case. |
BuyPrice |
Decimal |
The price at which the item is bought. Referenced by some reports in order to calculate cost prices where more detailed information is not available. |
WholesalePrice |
Decimal |
Wholesale price. |
RetailPrice |
Decimal |
Retail price. |
WeightMeasure |
String(10) |
Weight measure symbol (see Units of Measure). |
Height |
Decimal |
Height. |
Width |
Decimal |
Width. |
Depth |
Decimal |
Depth. |
DimensionMeasure |
String(10) |
Dimension measure symbol (see Units of Measure). |
Tags |
String(8000) |
A generic string field that can be used for searching within the web application. |
HSCode |
String(1000) |
A field that can be used to hold the harmonized product code for the product, which can be communicated to carrier integrations if required for international goods declarations. |
CountryOfOrigin |
String(1000) |
Can be used to indicate the source of the product. Typically, this would be the three-letter ISO code for the country in which the product originated, but check with your carrier partner in what format they may want this data. |
DryIce |
Boolean |
A flag to indicate whether the product consists of or contains dry ice. This may be used by some carrier partners when generating international goods declarations. |
MedicalDryIce |
Boolean |
A flag to indicate whether the product consists of or contains medical-grade dry ice. This may be used by some carrier partners when generating international goods declarations. |
Alcohol |
Boolean |
A flag to indicate whether the product consists of or contains alcohol. This may be used by some carrier partners when generating international goods declarations. |
Hazardous |
Boolean |
A flag to indicate whether the product consists of or contains potentially dangerous substances. This may be used by some carrier partners when generating international goods declarations. |
On hand |
Int |
On hand stock level (read only). |
Allocated |
Int |
Allocated stock (read only). |
Available |
Int |
Available stock level (read only). |
POQuantityOutstanding |
Int |
The quantity of the item currently outstanding on purchase orders (read only). |
The following units can be used for weights and dimensions:
EA (each)
l (litre)
dl (decilitre)
cl (centilitre)
ml (millilitre)
m3 (cubic metre)
ga (gallon)
pt (pint)
fl (fluid ounce)
g (gram)
kg (kilogram)
mg (milligram)
lb (pound)
oz (ounce)
Item Type Groups
Unique identifier: Name
Import and export:
Reference |
Type |
Description |
Name * |
String(1000) |
Item type group name. This is used to link items and additional item type groups. |
ParentGroup |
String(1000) |
The name of the immediate parent item group. Leave blank on import to assign to the highest level group (optional). |
Item Type Kittings
Unique identifier: The combination of ParentItemCode and ChildItemCode
Each item type kitting defines a relationship between exactly two items. Multiple kitting records work together to define the collection of components that make up a kit parent. The quantity represents the number of times a particular component appears in each kit.
One item can have multiple children, and one item can belong to multiple kits, but the parent/child combination is unique. Submitting a second kitting with the same parent and child but a different quantity will update the quantity of the existing record.
Import and export:
Requires: Item types.
Reference |
Type |
Description |
ParentItemCode * |
String(1000) |
The item code of the item to be the parent of the kit. |
ChildItemCode * |
String(1000) |
The item code of the item to be the child of the kit. |
Quantity |
Int |
The quantity of the child item that belongs to the parent item in the kit. |
Item Type Suppliers
Unique identifier: The combination of ItemCode and Supplier
Import and export:
Requires: Item types, Suppliers.
Reference |
Type |
Description |
ItemCode * |
String(1000) |
Item code. |
Supplier * |
String(1000) |
Supplier reference. |
DefaultEconomicOrderQuantity |
Int |
The best value purchase quantity of the item from this supplier. Not used internally by the WMS (optional). |
DefaultLeadTime |
Int |
The delivery time (in calendar days) of this item from this supplier. Not used internally by the WMS (optional). |
DefaultSuppliersPartNumber |
String(1000) |
The supplier’s unique identifier or barcode for the item. Must be unique amongst all barcodes if provided but can be scanned to identify the item (optional). |
IsPrimary |
Boolean |
Defines whether this is the primary supplier for the item (optional). |
Location Templates
Similarly to items, three related templates exist that are used to import/export various details concerning locations:
Locations: The details of the item locations themselves, including their barcodes.
Location group types: Defines the different components in the location group hierarchy (aisles, bays, etc.). A number of these are defined in PVX by default, but you can use this template if you want to add more.
Location groups: Defines the structure of the location hierarchy in the warehouse.
For the data in these templates to be imported successfully:
Import location group types first (if you are using custom location types).
Then import location groups.
Import locations last.
Locations
Unique identifier: Barcode
Import:
Requires: Location groups.
Reference |
Type |
Description |
Barcode * |
String(1000) |
The barcode of the location. This must be unique across all barcode fields and will be used to scan the location in the warehouse. |
Name * |
String(1000) |
A name for the location to help users identify it. |
Sequence |
Int |
The numerical sequence of the location within its local group. This is combined with the sequence of each parent to generate a unique sequence within the warehouse. |
LocationGroup * |
String(1000) |
Name of the location group under which to create this location. |
LocationUseType * |
String(1000) |
The use type of the location (Bulk, Despatch, Pick, Quarantine). This will influence the activities that can be performed upon the inventory in the location and may affect whether the inventory contributes to the available inventory of the warehouse. |
Export:
Reference |
Type |
Description |
Barcode |
String(1000) |
The barcode of the location (is unique across all barcode fields). |
Name |
String(1000) |
The name for the location to help users identify it. |
Sequence |
Int |
The numerical sequence of the location within its local group. This is combined with the sequence of each parent to generate a unique sequence within the warehouse. |
LocationGroup |
String(1000) |
Name of the location group that is the immediate parent of the location. |
LocationUseType |
String(1000) |
The use type of the location (Bulk, Despatch, Pick, Quarantine). This influences the activities that can be performed upon the inventory in the location and may affect whether the inventory contributes towards the available inventory of the warehouse. |
IPSequence |
String(1000) |
The combined sequence derived from the location group hierarchy and the sequence on the location (read only). |
Location Groups
Unique identifier: Name
Requires: Location group types.
Reference |
Type |
Description |
Name * |
String(1000) |
Name. |
BarcodePrefix * |
String(1000) |
The barcode prefix of the location group. Used to help users automatically generate new locations with unique barcodes using the web application. |
ParentLocationGroup |
String(1000) |
The name of the location group to be the immediate parent of this one. Leave blank to assign to the highest level of the location group hierarchy (optional). |
LocationGroupType * |
String(1000) |
The name of the type of this location group (e.g., bay, shelf, racking). This is a lookup to the location group types table, so the location group type must be created before it can be referenced here. Some default values are pre-defined by the system. |
Sequence |
Int |
The numerical sequence of the location group within the warehouse. It is combined with the sequence of other location groups in the hierarchy to generate the IP sequence for locations (optional). |
Site * |
String(1000) |
The reference of the site to which the location group belongs. |
Location Group Types
Unique identifier: Name
Reference |
Type |
Description |
Name * |
String(1000) |
Name |
Package Types
Unique identifier: Name
Import and export:
Reference |
Type |
Description |
Name * |
String(1000) |
Name |
Weight |
Decimal |
Weight (optional) |
Height |
Decimal |
Height (optional) |
Width |
Decimal |
Width (optional) |
Depth |
Decimal |
Depth (optional) |
ImageUrl |
String(1000) |
The URL of an image that represents this type of package. This will be displayed during the web app despatch process to help the user identify the package type (optional). |
Payment Methods
Unique identifier: PaymentType
Import and export:
Reference |
Type |
Description |
PaymentType * |
String(1000) |
The name of the payment type. |
Purchase Orders
Import:
Unique identifier: PurchaseOrderNumber
Requires: Suppliers
Optional: Supplier addresses
if you provide a supplier on the PO creation request, then the PO will be automatically submitted and available to receive. If you do not, then a user will need to manually submit the PO via the web app before it can be received.
Note: if you want to provide an address against the PO, please do not provide one against the supplier.
You can update purchase order information at any time before receiving starts. Once any item is received against the purchase order and it enters the "Receiving" status, no further changes can be made to the purchase order header data. However, purchase order item lines can still be added, removed or edited at any point, even after the order is fully received and adding new lines at that stage can reopen a completed PO.
Reference |
Type |
Description |
PurchaseOrderNumber * |
String(1000) |
Purchase order number. This is the unique identifier for the purchase order. |
Status |
String(1000) |
Purchase order status name. For imports, only "cancelled" is accepted; all other statuses are read-only (optional) (see Purchase order statuses). |
Reference |
String(1000) |
A string reference that can be applied to the order to help users identify and search for it (optional). |
SupplierReference |
String(1000) |
The reference of the supplier record to be linked to the purchase order (optional). |
AddressLine1 |
String(1000) |
Line 1 (optional). |
AddressLine2 |
String(1000) |
Line 2 (optional). |
AddressCity |
String(1000) |
City (optional). |
AddressRegion |
String(1000) |
Region (optional). |
AddressPostcode |
String(1000) |
Post code (optional). |
AddressCountry |
String(1000) |
Country (optional). |
AddressReference |
String(1000) |
Address reference (optional - if a reference is provided alongside address data, the reference will be prioritised, and the provided address data will be ignored). |
RequestedDeliveryDate |
Date |
Requested date in “yyyy-MM-dd HH:mm:ss” format (optional). |
SubmittedDate |
Date |
Submitted date in “yyyy-MM-dd HH:mm:ss” format (optional). |
EndDate |
Date |
End date in “yyyy-MM-dd HH:mm:ss” format (optional). |
ExpectedDeliveryDate |
Date |
Expected delivery date in “yyyy-MM-dd HH:mm:ss” format (optional). |
Site * |
String(1000) |
The reference of the site to which the purchase order will be assigned. |
Export:
Reference |
Type |
Description |
PurchaseOrderNumber |
String(1000) |
Purchase order number. This is the unique identifier for the purchase order. |
Status |
String(1000) |
Purchase order status name (see Purchase order statuses). |
Reference |
String(1000) |
A string reference that can be applied to the order to help users identify and search for it. |
Supplier |
String(1000) |
The name of the supplier record linked to the purchase order. |
AddressLine1 |
String(1000) |
Line 1. |
AddressLine2 |
String(1000) |
Line 2. |
AddressCity |
String(1000) |
City. |
AddressRegion |
String(1000) |
Region. |
AddressPostcode |
String(1000) |
Post code. |
AddressCountry |
String(1000) |
Country. |
AddressReference |
String(1000) |
Address reference. |
RequestedDeliveryDate |
Date |
Requested date in “yyyy-MM-dd HH:mm:ss” format. |
SubmittedDate |
Date |
Submitted date in “yyyy-MM-dd HH:mm:ss” format. |
EndDate |
Date |
End date in “yyyy-MM-dd HH:mm:ss” format. |
ExpectedDeliveryDate |
Date |
Expected delivery date in “yyyy-MM-dd HH:mm:ss” format. |
Site |
String(1000) |
The reference of the site to which the purchase order is assigned. |
User |
String(20) |
The name of the user that created the purchase order. |
Purchase Order Items
Unique identifier: Combination of PurchaseOrderNumber, ItemCode and Line
Requires: Purchase orders, Item types
Note: Purchase order items can be added, removed or modified at any point in the purchase order lifecycle. Adding new items to a completed purchase order will reopen that PO. Removing outstanding items from a purchase order that is already partially received can cause the purchase order to close if all remaining item lines are fully received. Item lines that have already been received cannot be removed.
Import and export:
Reference |
Type |
Description |
PurchaseOrderNumber * |
String(1000) |
The purchase order number of the purchase order to which the items should be attached. |
ItemCode * |
String(1000) |
The item code of the items to be received. |
Status |
String(1000) |
Purchase order item type status name (optional) (see Purchase order items statuses). |
Quantity |
Int |
The quantity of the item to be received. |
Line |
String(1000) |
A unique identifier for the item line. No two lines on a purchase order can share both an item code and a line number. Providing different line numbers allows the same item to appear more than once on a purchase order (optional). |
Sequence |
Int |
Sequence (optional). |
CostPrice |
Decimal |
The price at which the goods were purchased (optional). |
ExpectedDeliveryDate |
Date |
Expected delivery date in “yyyy-MM-dd HH:mm:ss” format (optional). |
Removals
Unique identifier: Barcode
Reference |
Type |
Description |
Name * |
String(1000) |
The name of the removal reason. |
Description |
String(1000) |
The description of the removal reason (optional). |
Barcode * |
String(1000) |
The barcode of the removal reason. |
Site * |
String(1000) |
The reference of the site to which the removal reason belongs. |
Return Authorizations
Unique identifier: ReturnAuthorizationNumber
Import only.
Reference |
Type |
Description |
ReturnAuthorizationNumber * |
String(1000) |
The unique identifier of the return authorization. |
SalesOrderNumber |
String(1000) |
The sales order to which the return is linked (optional). |
ReturnAuthorizationStatus |
String(1000) |
The status of the return authorization. In most cases, this will be calculated by Peoplevox, so the only value that is accepted on the import here is "Cancelled"; otherwise, this should not be provided on the import. Cancelling the authorization will cancel all attached item lines (optional). |
ReturnTrackingNumber |
String(1000) |
A tracking number linked to the return, which can be scanned during the returns workflow (optional). |
ReturnExpectedDeliveryDate |
Date |
The date that the return is expected to arrive at the warehouse (optional). |
ReturnSenderName |
String(1000) |
The name of the person sending the return (optional). |
ReturnAuthorizationComments |
String(1000) |
Any comments about the return (e.g., whether fraud is suspected). This can be configured to show during the returns workflow (optional). |
SiteReference |
String(1000) |
The warehouse expected to receive the return (optional). |
CustomerPurchaseOrderReferenceNumber |
String(1000) |
This optional field provides an alternative way to link the RMA to a sales order. If a value is provided, the system looks for sales orders with a matching This is useful when orders are routed through a middleware layer, such as a marketplace management system. In these scenarios, the middleware may assign a new order number before the order reaches the WMS, while customer return portals continue to use the original sales order number from the sales channel. |
ExternalReference |
String(1000) |
A free-text field that can be used to hold a reference number, such as a sales order number from an external system. This field is not used to link RMAs to orders but can be used to search for RMAs that may be related to orders that are not in the WMS (optional). |
Return Authorization Items
Unique identifier: Combination of ReturnAuthorizationNumber, ItemCode, and ReturnAuthorizationItemLineNumber
Requires: Return authorizations, item types, return reasons
Import only
Reference |
Type |
Description |
ReturnAuthorizationNumber * |
String(1000) |
The unique identifier of the return authorization. |
ItemCode * |
String(1000) |
The item code of the product to be returned. |
ReturnAuthorizationItemLineNumber |
String(1000) |
A unique identifier for the item line. No two lines on a return authorization can share both an item code and a line number. Providing different line numbers allows the same item to appear more than once on an authorization (optional). |
ReturnAuthorizationItemStatus |
String(1000) |
The status of the item authorization. In most cases, this will be calculated by Peoplevox, so the only value that is accepted on the import here is "Cancelled"; otherwise, this should not be provided on the import. Cancelling an individual item line will recalculate the status of the authorization (optional). |
ReturnReason |
String(1000) |
The reason that the sender provided for returning the item. The value provided here should be the code of a return reason that exists in Peoplevox (optional). |
ReturnExpectedState |
String(1000) |
The expected state of the item, as described by the person sending the return. The value provided here should be the code of a return state that exists in Peoplevox (optional). |
ReturnAuthorizationItemComments |
String(1000) |
This optional field allows you to add comments or guidance for a specific return item—for example, noting any special processing steps or checks the operator should perform. These comments can be configured to display during the returns workflow. |
Quantity |
Int |
The amount of the product that is expected to be returned on this line. |
Return Reasons
Unique identifier: Code
Reference |
Type |
Description |
Code * |
String(1000) |
The return-reason code; This is typically a short two- or three-letter identifier used for quick reference. |
Description |
String(1000) |
A longer description of the return reason (optional). |
Roles
Unique identifier: Name
Reference |
Type |
Description |
Name * |
String(1000) |
The name of the role. |
Sales Orders
Unique identifier: SalesOrderNumber
Optional: Customers, Customer addresses, Service types, Payment methods
Importing from this template may require Customers, Customer addresses, Payment methods and Service types to be imported/created first depending on the fields selected for import. For example, you can only import a value in the ServiceType field if it matches a carrier service code that already exists in PVX; otherwise, the field will be blank.
Note: Like most other records, sales orders can be updated after they are created. If a picking action has been created for the order, the system will normally remove that action to permit the update. However, once the picking action has started—meaning an operator is actively picking—the action cannot be removed, and the order can no longer be updated.
Import:
Reference |
Type |
Description |
SalesOrderNumber * |
String(1000) |
The unique order number of the sales order. |
Customer |
String(1000) |
The Reference of the customer to link to the order (optional). |
CustomerPurchaseOrderReferenceNumber |
String(1000) |
A free-text reference field to help identify and search for the order (optional). |
ShippingAddressLine1 |
String(1000) |
Line 1 (optional). |
ShippingAddressLine2 |
String(1000) |
Line 2 (optional). |
ShippingAddressCity |
String(1000) |
City (optional). |
ShippingAddressRegion |
String(1000) |
Region (optional). |
ShippingAddressPostcode |
String(1000) |
Post code (optional). |
ShippingAddressCountry |
String(1000) |
Country (optional). |
ShippingAddressReference |
String(1000) |
Reference (optional). If a reference is provided alongside address data, the reference will be prioritised, and the provided address data will be ignored). |
InvoiceAddressLine 1 |
String(1000) |
Line 1 (optional). |
InvoiceAddressLine 2 |
String(1000) |
Line 2 (optional). |
InvoiceAddressCity |
String(1000) |
City (optional). |
InvoiceAddressRegion |
String(1000) |
Region (optional). |
InvoiceAddressPostcode |
String(1000) |
Post code (optional). |
InvoiceAddressCountry |
String(1000) |
Country (optional). |
InvoiceAddressReference |
String(1000) |
Reference (optional). If a reference is provided alongside address data, the reference will be prioritised and the provided address data will be ignored). |
IsPartialShipment |
Boolean |
A flag that controls whether the order can be released for picking while partially allocated. If true, then the order can be released as soon as any item becomes available. If false, then the entire order must be allocated before it can be released (optional, false by default). |
Status |
String(1000) |
The name of the status. Only the “cancelled” status is permitted on imports; all other statuses are read-only (optional) (see Sales order statuses). |
RequestedDeliveryDate * |
Date |
Requested date in “yyyy-MM-dd HH:mm:ss” format. |
ShippingCost |
Decimal |
Shipping cost (optional). |
String(1000) |
Email (optional). |
|
ContactName |
String(1000) |
Contact name (optional). |
TotalSale |
Decimal |
Total sale (optional). |
Discount |
Decimal |
Discount (optional). |
TaxPaid |
Decimal |
TaxPaid (optional). |
CreatedDate |
Date |
Created date in “yyyy-MM-dd HH:mm:ss” format (optional). |
PaymentMethod |
String(1000) |
The name of the payment method used on the order (optional). |
ServiceType |
String(1000) |
The service type code to assign to the order. The service type must be created prior to referencing it on the order (optional). |
ChannelName |
String(1000) |
The name of the sales channel, or order source (optional). |
OnHold |
Boolean |
A flag that controls whether the order can be released for picking. Inventory will still be allocated, but the order will only be releasable for picking if this is set to “false” (optional, defaults to false). |
Attribute1 |
String(1000) |
Generic sales order attribute (optional). |
Attribute2 |
String(1000) |
Generic sales order attribute (optional). |
Attribute3 |
String(1000) |
Generic sales order attribute (optional). |
Attribute4 |
String(1000) |
Generic sales order attribute (optional). |
Attribute5 |
String(1000) |
Generic sales order attribute (optional). |
StopShip |
Boolean |
A flag that blocks the despatch of a sales order if set to true. You will still be able to allocate and pick the order, but operators will be unable to despatch it until this flag is set to false. (This is not currently supported on mobile despatch methods but is expected in the future.) |
Site * |
String(1000) |
The reference of the site to which the order should be assigned. |
DespatchTrackingNumber |
String(1000) |
The tracking number to assign to the despatch linked to this order. This can only be supplied after the order has been despatched. Typically, this is provided by carrier integrations (optional). |
TermsOfTrade |
String(1000) |
Shipping attribute. Used to indicate incoterms (DDU, DDP, etc.) (optional). |
Currency |
String(1000) |
Shipping attribute. The currency in which the order was placed (optional). |
CustomsRegistrationNumber |
String(1000) |
Shipping attribute. The VAT number (or territorial equivalent) of the recipient of the order (optional). |
IOSSNumber |
String(1000) |
Shipping attribute. Your IOSS number (optional). |
DeliveryNotes |
String(1000) |
Shipping attribute. Notes that the customer may have entered against the order to be shown to the delivery agent (optional). |
ContentsType |
String(1000) |
Shipping attribute. A high-level indicator of the type of goods being shipped (e.g., gift, merchandise, etc.) and typically relevant for international shipments (optional). |
Note: Properties marked "shipping attribute" can be imported but are not used by PVX within the warehouse. These fields are exposed to shipping integrations but check with your shipping partner whether they leverage these.
Export:
As for import except Status, it can be set to "Allocated", "Being picked", "Picked", "Despatched", "Partially allocated", "Partially picked" or "Partially despatched" by PVX (read-only field).
Reference |
Type |
Description |
SalesOrderNumber |
String(1000) |
The unique order number of the sales order. |
Customer |
String(1000) |
The Account name of the customer linked to the order. |
CustomerPurchaseOrderReferenceNumber |
String(1000) |
A free-text reference field to help identify and search for the order. |
ShippingAddressLine1 |
String(1000) |
Line 1. |
ShippingAddressLine2 |
String(1000) |
Line 2. |
ShippingAddressCity |
String(1000) |
City. |
ShippingAddressRegion |
String(1000) |
Region. |
ShippingAddressPostcode |
String(1000) |
Post code. |
ShippingAddressCountry |
String(1000) |
Country. |
ShippingAddressReference |
String(1000) |
Reference. |
InvoiceAddressLine 1 |
String(1000) |
Line 1. |
InvoiceAddressLine 2 |
String(1000) |
Line 2. |
InvoiceAddressCity |
String(1000) |
City. |
InvoiceAddressRegion |
String(1000) |
Region. |
InvoiceAddressPostcode |
String(1000) |
Post code. |
InvoiceAddressCountry |
String(1000) |
Country. |
InvoiceAddressReference |
String(1000) |
Reference. |
IsPartialShipment |
Boolean |
A flag that controls whether the order can be released for picking while partially allocated. If true, then the order can be released as soon as any item becomes available. If false, then the entire order must be allocated before it can be released. |
Status |
String(1000) |
The name of the status. Only the “cancelled” status is permitted on imports; all other statuses are read-only (see Sales order statuses). |
RequestedDeliveryDate |
Date |
Requested date in “yyyy-MM-dd HH:mm:ss” format. |
ShippingCost |
Decimal |
Shipping cost. |
String(1000) |
Email. |
|
ContactName |
String(1000) |
Contact name. |
TotalSale |
Decimal |
Total sale. |
Discount |
Decimal |
Discount. |
TaxPaid |
Decimal |
TaxPaid. |
CreatedDate |
Date |
Created date in “yyyy-MM-dd HH:mm:ss” format. |
PaymentMethod |
String(1000) |
The name of the payment method used on the order. |
ServiceType |
String(1000) |
The service type code to assign to the order. The service type must be created prior to referencing it on the order. |
ChannelName |
String(1000) |
The name of the sales channel or order source. |
OnHold |
Boolean |
A flag that controls whether the order can be released for picking. Inventory will still be allocated, but the order will only be releasable for picking if this is set to “false”. |
Attribute1 |
String(1000) |
Generic sales order attribute. |
Attribute2 |
String(1000) |
Generic sales order attribute. |
Attribute3 |
String(1000) |
Generic sales order attribute. |
Attribute4 |
String(1000) |
Generic sales order attribute. |
Attribute5 |
String(1000) |
Generic sales order attribute. |
StopShip |
Boolean |
A flag that blocks the despatch of a sales order if set to true. You will still be able to allocate and pick the order, but operators will be unable to despatch it until this flag is set to false. (This is not currently supported on mobile despatch methods but is expected in the future.) |
Site |
String(1000) |
The reference of the site to which the order is assigned. |
TermsOfTrade |
String(1000) |
Shipping attribute. Used to indicate incoterms (DDU, DDP, etc.). |
Currency |
String(1000) |
Shipping attribute. The currency in which the order was placed. |
CustomsRegistrationNumber |
String(1000) |
Shipping attribute. The VAT number (or territorial equivalent) of the recipient of the order. |
IOSSNumber |
String(1000) |
Shipping attribute. Your IOSS number. |
DeliveryNotes |
String(1000) |
Shipping attribute. Notes that the customer may have entered against the order to be shown to the delivery agent. |
ContentsType |
String(1000) |
Shipping attribute. A high-level indicator of the type of goods being shipped, (e.g., gift, merchandise, etc.) typically relevant for international shipments. |
Sales Order Items
Unique identifier: Combination of SalesOrderNumber, ItemCode and Line
Requires: Sales orders, Item types
Import and export:
Reference |
Type |
Description |
SalesOrderNumber * |
String(1000) |
The order number of the sales order to which the item line should be linked. |
ItemCode * |
String(1000) |
The item code of the item to link to the sales order. |
QuantityOrdered |
Int |
Quantity ordered. |
RequestedDeliveryDate |
Date |
Requested date in “yyyy-MM-dd HH:mm:ss” format (optional). |
Line |
String(1000) |
A unique identifier for the item line. No two lines on a sales order can share both an item code and a line number. Providing different line numbers allows the same item to appear more than once on a sales order (optional). |
Sequence |
Int |
Sequence (optional). |
SalePrice |
Decimal |
Sale price (optional). |
Attribute1 |
String(1000) |
Generic sales order item attribute (optional). |
Attribute2 |
String(1000) |
Generic sales order item attribute (optional). |
Attribute3 |
String(1000) |
Generic sales order item attribute (optional). |
Service Types
Unique identifier: Code
Requires: Carriers
Import and export:
Reference |
Type |
Description |
Carrier * |
String(1000) |
Carrier name. |
Name |
String(1000) |
Service type name (optional). |
Code * |
String(1000) |
The code used to refer to the service type. |
Sites
Unique identifier: Reference
Import and export:
Reference |
Type |
Description |
Name * |
String(1000) |
Name. |
Reference |
String(1000) |
Unique site reference, used to refer to the site. |
Suppliers
Unique identifier: Reference
Import and export:
Reference |
Type |
Description |
Name |
String(1000) |
Supplier name. |
Reference * |
String(1000) |
Unique supplier reference. |
FirstName |
String(1000) |
First name (optional). |
LastName |
String(1000) |
Last name (optional). |
Phone |
String(1000) |
Phone number (optional). |
Mobile |
String(1000) |
Mobile number (optional). |
String(1000) |
Email (optional). |
|
CreditLimit |
Decimal |
CreditLimit (optional). |
Notes |
String(1000) |
Free-text field for storing notes against the supplier (optional). |
Supplier Addresses
Unique identifier: AddressReference
Requires: Suppliers
Import:
Reference |
Type |
Description |
SupplierReference * |
String(1000) |
The unique reference of the supplier to which the address should be linked. |
AddressLine1 |
String(1000) |
Line 1 (optional). |
AddressLine2 |
String(1000) |
Line 2 (optional). |
AddressCity |
String(1000) |
City (optional). |
AddressRegion |
String(1000) |
Region (optional). |
AddressPostcode |
String(1000) |
Post code (optional). |
AddressCountry |
String(1000) |
Country (optional). |
AddressReference |
String(1000) |
Reference (optional). |
Export:
Reference |
Type |
Description |
SupplierReference |
String(1000) |
The reference of the supplier to which the address is linked. |
AddressLine1 |
String(1000) |
Line 1. |
AddressLine2 |
String(1000) |
Line 2. |
AddressCity |
String(1000) |
City. |
AddressRegion |
String(1000) |
Region. |
AddressPostcode |
String(1000) |
Post code. |
AddressCountry |
String(1000) |
Country. |
AddressReference |
String(1000) |
Reference. |
SupplierName |
String(1000) |
The name of the linked supplier. |
Tax Codes
Unique identifier: TaxCodeName
Import and export:
Reference |
Type |
Description |
TaxCodeName * |
String(1000) |
Tax code name. |
TaxCodePercentage |
Decimal |
Tax code percentage (optional). |
Users
Unique identifier: Username
Import:
Reference |
Type |
Description |
Username * |
String(1000) |
Username. |
Password * |
String(1000) |
Password text (edit only). |
Role * |
String(1000) |
The name of the role to which the user should be linked. |
DisplayName |
String(1000) |
Display name (optional). |
String(1000) |
Email (optional). |
Export:
Reference |
Type |
Description |
Username |
String(1000) |
Username. |
Role |
String(1000) |
The name of the role to which the user should be linked. |
DisplayName |
String(1000) |
Display name (optional). |
String(1000) |
Email (optional). |
Reference Values
In addition to the templates, symbols and status values are used for some of the fields.
Units of Measure
Value |
Description |
EA |
Unit |
l |
Litre |
dl |
Decilitre |
cl |
Centilitre |
ml |
Millilitre |
m3 |
Cubic metre |
ga |
Gallon |
pt |
Pint |
fl |
Fluid Ounce |
g |
Gram |
kg |
Kilogram |
mg |
Milligram |
lb |
Pound |
oz |
Ounce |
Purchase Order Statuses
Value |
"Not yet submitted" |
"Submitted" (read only) |
"Receiving" (read only) |
Complete" (read only) |
Cancelled" |
Deleted" |
Purchase Order Item Statuses
Value |
"Pending" |
"Complete" (read only) |
"Closed" |
Sales Order Statuses
Note: if you are attempting to set the status to "Cancelled" via an order import, you will need to use the “Value”, not the ID.
ID |
Value |
0 |
"New" |
2 |
"Allocated" (read only) |
3 |
"Being picked" (read only) |
4 |
"Picked" (read only) |
5 |
"Despatched" (read only) |
6 |
"Cancelled" |
7 |
"Partially allocated" (read only) |
8 |
"Partially picked" (read only) |
9 |
"Partially despatched" (read only) |