Technical Documention

Owned by Shanley Compton (Unlicensed)
Last updated: Aug 16, 2021
2 min read

1. Goals

Give retailers the ability to receive stock directly into their Peoplevox WMS.

2. Assumptions

  • Retailer needs to be using Peoplevox as a WMS.

  • OmniRPS needs to know if a parcel is been scanned by customer HUB or Seko Hub based on the HUB location of the user who is scanning the parcel.

  • Freight not to be process in stock if it’s damage.

  • OmniRPS should have the data before the scan.

  • PeopleVox to auto accept all stock into quarantine.

  • For this integration to work all parcels will be opened and Item checked.

3. Configuration

  • There should be an option in OmniRPS under third party configuration called “PeopleVox”

  • Add all required settings for PeopleVox integrations like API key, URL etc

  • Timing to send PO for retailer HUB (Configuration by hub) o ImmediateBatched (1hr, 2hr etc) o Textbox for timing in minutes.

  • Timing to send PO for cross border parcels. o At the time of consolidating the freight. (Export Process in RPS)

4. Technical documentation

API Authentication

Calls to the API take the form of an HTTP POST request followed by the relevant HTTP Headers (content type and content length), and the SOAP envelope in the body of the message. The API supports requests for both SOAP 1.1 and SOAP 1.2.

An example of a call to the Authenticate API method using SOAP 1.1 is described below. Authenticate Parameters:

  • string: clientid

  • string: username

  • string: password – this need to be encoded in base64 encoding.

Return value:
IntegrationResponse: ResponseId, 0 if call has succeeded, -1 if failed
TotalCount: contains 1 if the authentication has succeeded otherwise 0.
Detail: contains the session id if the call is successful, otherwise it contains the error detail.

Save Data API

To create a new returns purchase order, we need to run the SaveRequest API for PeopleVox. We will need to specifically save data for Purchase Orders and Purchase Order Items.
https://peoplevox.github.io/Documentation/#226-saverequest https://peoplevox.github.io/Documentation/#227-templates

 

5. Data flow