Introduction
The Peoplevox Warehouse Management System (WMS) provides an API to allow clients and partners to write integrations into the WMS. This document will describe the features offered by the API, how an integrator is expected to talk to the API, and what the expected results & responses are.
Broadly speaking, the API is used by integrators to push data to the WMS, and the WMS would typically send data back to another system via a webhook process.
The API also provides the ability for integrators to search for data within the system and run reports, the results of which are returned on the API response.
The primary goal of the API is to allow the exchange of data between PVX and third-party systems; in a very basic textbook integration example, a third- party system would send order data from an ecommerce platform to the WMS, the orders would be picked, packed, and despatched, and the WMS would notify the third-party system of the despatch and any resulting changes in inventory.
WMS API Overview
The API is a SOAP service, and the description (WSDL) file can be found at the following address:
https://{your-WMS-Web-Address}/resources/integrationservicev4.asmx?wsdl
The definitions can also be viewed in a web browser at the following address:
https://{your-WMS-Web-Address}/integrationservicev4.asmx
The {your-WMS-Web-Address} placeholder refers to the URL provided by Peoplevox to access the Peoplevox web application. For a typical production environment, the URL is “wms.peoplevox.net/ClientId”, where the ClientId refers to the unique identifier assigned by Peoplevox to the client. Testing environments may use different URL formats.
An example URL for a production environment of a client “MyClientId” would be:
https://wms.peoplevox.net/myclientid/integrationservicev4.asmx
The API uses the SOAP protocol for framing the request and response, but when sending and requesting data to and from the system, that data is sent in CSV format, wrapped by the SOAP envelope. See the relevant sections below for examples of this.
Changes
Note: We may make changes to the API from time to time when we release new features. If we’re releasing a backwards-compatible change then we’ll update the existing API version. Your integration should be prepared to handle these changes without warning. Backwards-compatible changes include:
New fields added to API requests and responses
New properties added to integration templates
New API methods
Changing the order of properties within existing API types
If we need to release a potentially breaking change, such as a change to an existing API response type, we’ll publish this against a new version of the API to ensure that your integrations aren’t affected until you’re ready.
IP Whitelisting
Please ensure that your firewall allows access from these addresses to ensure your integration works correctly:
99.81.126.126
13.58.7.144
13.236.234.230
3.212.17.174
3.24.26.71
34.249.107.178
Please also ensure that your Intrusion Detection System and any other software managing the border of your network is updated with these IP addresses. Failure to do so will prevent aspects of your system from working.