...

Author

...

Intelligent Shipper
Label Print Webhook Setup
Version 2.0

...

Document Owner

...

INTERSOFT Systems and Programming Limited

...

Version

...

2.0

...

Date

...

06/08/2020

...

Description

...

Instructs System Administrator users how to setup a print label webhook, for automated label printing from the Till Pack and DC Scanning screens.

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.

Anchor
_Toc46951734 _Toc46951734

Document Controls

Version History

Review

Referenced Documents

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

Anchor
_Toc46951735 _Toc46951735

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

Anchor
_Toc46951736 _Toc46951736

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.

Anchor
_Toc46951737 _Toc46951737

Webhook - Label Print Set up

1. Access Webhook screen From Intelligent Shipper> Maintenance Menu
2. Select Label Print option

Label Print screen is displayed with the below fields:

1. Authentication type will be populated with OAuth2 by default and will be disabled
2. Enter URL for Print Label API.
3. URL of the Client API the Print label webhook request will be sent to
4. Enter Token URL
5. Enter Client ID for the Print Label API
6. Enter Secret for the Print Label API
7. Enter the Test Scanning Location by either entering the scanning location name and click search to find the specific location or leave the field blank and click search to select from the list of scanning locations displayed.

1. Click the Test button. This will validate all fields have been populated and validates if the Scanning location entered is a valid and exists in the Scanning Locations maintenance screen. If the validation fails an error messaged returned. If all fields populated are valid then a test Print label request is sent to the webhook to validate the URL and credentials entered. If this is successful, then a HTTP 200 response is displayed in a pop-up window.

1. Where the test Print label has been unsuccessful then a HTTP 500 response with error message is displayed.

...

1. Anchor
   _Level_3_Heading _Level_3_Heading

   The Active check box will be enabled once a successful HTTP 200 response is received.

1. Check the Active checkbox.
2. Click Save
3. The Print Label webhook is now active. When labels are be printed from the Till Pack & DC Scanning screens, the label image will be sent in a webhook request to the Client API configured in the Label Print Webhook screen. The webhook request will contain the label printer name in the Scanning Locations maintenance screen for the location the shipment was scanned on.

Anchor
_Toc46951741 _Toc46951741

Edit an Active Webhook

To edit an active webhook:

1. Access Webhook option From Intelligent Shipper> Maintenance Menu
2. Select Label Print option
3. Label Print screen is displayed and all the fields on the page are disabled.

1. Click the Edit Button
2. A confirmation message is displayed.

Note: When editing an existing active webhook, the webhook requires retesting and a successful HTTP Response must be received.

1. Selecting No on the confirmation message will direct you back to Step 3.
2. Select Yes to proceed
3. Print Label page is displayed. The fields will now be editable. The Active check box will be disabled

Image Modified

Anchor
_Toc46951728 _Toc46951728

Figure 9 - Label Print Webhook- Fields are editable

1. Once the required fields have been edited, select the Test button.
2. Upon a successful HTTP 200 response, the Active check box is enabled again.
3. Activate the Webhook by checking Active checkbox.
4. Click Save.
5. Webhook is now retested and active

   Anchor
   _Heading_Level_3 _Heading_Level_3

   .

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

Anchor
_Toc46951742 _Toc46951742

Appendix 1 – Print Label Webhook XML

Below is an example of the Print Label webhook xml that will be sent to the configured API:
{
"TillBarcode": "00000699973149161013193999",
"Location": {
"LocationName": "Beauty",
"PrinterName": "WSD-2545vfd-df45h-sndb-jgjjhj5255",
},
"Label": {
"Agent": "DHL",
"TrackingNumber": "JD25645455554565",
"B64LabelImage": "SkdCIDYyMDlHMjNBMDA2O(…truncated)",
"CreatedDateTime": "28/10/2019 14:25:12"
}
}

Appendix 1 – Glossary