This part of the platform is still under construction. In the future, you will be able to submit an API request to Peoplevox to register your endpoint and provide the relevant credentials that Peoplevox will then need to submit shipment data. In the interim, please contact Peoplevox directly if you wish to build an integration on this platform.
Linking your endpoint to documents in Peoplevox
Once you have registered your endpoint, a user in Peoplevox will then need to link your connection to print templates within Peoplevox.
The print templates are what the pack bench operator will interact with during the despatch process. When performing a despatch, they will request that Peoplevox prints one or more templates. If one of those templates is linked to your connection, then Peoplevox will trigger a call out to your endpoint.
If your endpoint responds with a URL to a new document, then Peoplevox will replace the template that the user queued with your document.
If your endpoint responds with an error or is unable to respond within the timeout, then the Peoplevox platform will simply print the document that the user queued (these Peoplevox templates are known as “failovers”).
Peoplevox Clients are encouraged to design these failover templates to be visually distinct from the labels that pack bench operators would typically receive from carriers. This ensures that the operator is immediately aware that a problem has occurred with that package, and they can set it aside and move on to the next.
For this reason, Clients are also encouraged to make sure that the failover templates contain enough information to be able to easily identify the package later.
A good example of a failover template would have a large-print warning message at the top, and include a barcode that represents the sales order number, as well as potentially address information and a list of the items in the package. That ensures that the order can easily be identified later, and the user can confirm that the package still contains the expected items.