Print Label Webhook Set up v2.0
Commercial and in Confidence
The information contained in this document is confidential. No part of this document may be reproduced, disclosed to any third party, or issued in any form or by any means without the express written permission of Intersoft Systems & Programming Ltd.
Document Controls
Version History
Version | Amendments | Date | Author |
|---|---|---|---|
0.1 | Draft | 17/07/2020 | Mujeeb Mohammad |
0.2 | Feedback updated from Peer review | 24/07/2020 | Mujeeb Mohammad |
1.0 | Final version | 29/07/2020 | Mujeeb Mohammad |
2.0 | Added appendix 1 print label webhook xml | 06/08/2020 | Mujeeb Mohammad |
Review
Name | Title | Date Reviewed | Version Reviewed |
|---|---|---|---|
Laura Price | Head of Business Analysis | 23/07/2020 | 0.1 |
Laura Price | Head of Business Analysis | 06/08/2020 | 2.0 |
Referenced Documents
Document Name | Version | Location (e.g. Link to Shared Drive, SharePoint etc.) |
|---|---|---|
N/A | N/A | N/A |
Contents
1. Document Controls
2. Table of Figures
3. Introduction
4. Webhook - Label Print Set up
5. Edit an Active Webhook
6. Appendix 1 – Glossary
Table of Figures
Figure 1 - Label Print Page
Figure 2 - Field descriptions
Figure 3 - Label Print - Webhook fields
Figure 4 - Successful HTTP 200 Response
Figure 5 - HTTP 500 - Unsuccessful Response
Figure 6 - Successful Response - Active checkbox is enabled
Figure 7 - Print Label - Edit
Figure 8 - Print Label - Edit - Confirmation Message
Figure 9 - Label Print Webhook- Fields are editable
Introduction
When a final mile label is created from Till Pack screen or DC Repack screen, the label image can be sent via Webhook to the customer's system. This allows the label to be automatically printed to the configured printer, without a user needing to download or manually print the label. If an active webhook does not exist, then labels cannot be printed automatically from the Till Pack and DC Scanning Screens. The user will need to manually download and print the labels.
This Webhook must be developed by the customer and hosted in their environment, making it available to Intersoft Cloud environment and producing an oAuth2 authentication token.
This user manual will instruct how to setup and activate the webhook in Intelligent Shipper, so that label print requests can be sent to the customer's webhook.
Webhook set up access is available to System Admin users.
Webhook - Label Print Set up
To set up and activate webhook:
Access Webhook screen From Intelligent Shipper> Maintenance Menu
Select Label Print option
Label Print screen is displayed with the below fields:
Figure 1 - Label Print Page