Printer's Plan - ShipLeap Integration Guide Follow

Printer’s Plan - ShipLeap Integration Guide

The Printer’s Plan shipping integration allows shipment data originating from Printer’s Plan to be captured and sent to a third-party shipping software solution. Likewise, shipment data generated from the shipping software can automatically be added to Printer’s Plan.

The integration with third-party shipping software solutions is part of the 2021 update of Printer’s Plan and requires the latest version of the Printer’s Plan API (Web2Plan).

ShipLeap has published a help article to assist you in collecting the information you will need for this integration.: https://shipleap.freshdesk.com/support/solutions/articles/48001178209 

Part 1: Integration Settings

Create a Shipping Integration.

In Printer's Plan go to the Settings section, open the Third Party Integrations folder, and select Shipping. This will open the Shipping Integrations window:

 

In the Shipping Integrations window click New and enter the following information:

  • Name: Enter ShipLeap
  • Username: Enter your ShipLeap username.
  • Password: Enter your ShipLeap password.
  • Secret Key and Webhook are not required. 
  • Click Set as Default to set the ShipLeap as the default. This default integration is applied when creating a new shipment.
  • Click Save and Close to save the integration.
  • Click Generate Config File 

ShipLeap.png

Part 2: Configure ShipLeap™

To allow ShipLeap to connect to Printer's Plan the URL of the Printer's Plan ShipApiListener needs to be configured in ShipLeap. This URL will have the following format: https://<ipaddress>/PlanWeb/ShipApiListener.aspx

The ShipApiListener is available with the latest version of the Printer’s Plan API (Web2Plan).  

 

Part 3: Advanced Settings - Edit the Shipment Configuration file.

As part of the shipping integration Printer’s Plan creates a configuration file named ShippingConfig.txt. This file is located in the Shipments folder, which resides in the directory where the Printer’s Plan database file is stored.

The data in the configuration file is used to set defaults for a shipping integration. In this file, you can establish the API configuration codes for each shipping carrier and shipping service. Additionally, you can set the default cost and markup rates for each shipping carrier for each shipping integration.

This text in this file is structured in JSON format and can be edited using Windows Notepad. We suggest making a backup of this file before making any changes. When you open this file, each shipping integration will be listed by its Integration ID. Under each integration is a listing of the Printer’s Plan Shipping Methods (Carriers) and Shipping Services:

 

The Integration ID can be found in the last column of the Shipping Integrations window:

 

 

 

For each Shipping Integration the following options can be configured:

Set the API Codes for each Shipping Carrier (Method)

Setting the API Codes for each Shipping Carrier (Method) creates a mechanism that allows you to map the Printer’s Plan shipping carrier with the corresponding carrier in the third-party shipping software. To set the API codes for the shipping carriers do the following:

  1. Open the configuration file ShippingConfig.txt.
  2. Find the section for the integration (by Integration ID).
  3. For each Method, in the “ApiCode” field enter the text for the API code.
  4. Save the file.

Set the API Code for the Shipping Service

Setting the API Codes for each Shipping Service creates a mechanism that allows you to map the Printer’s Plan shipping service with the corresponding service in the third-party shipping software. To set the API codes for the shipping carriers do the following:

  1. Open the configuration file ShippingConfig.txt.
  2. Find the section for the integration (by Integration ID).
  3. For each Service, in the “ApiCode” field enter the text for the API code.
  4. Save the file.

Set a Default Shipping Cost

To set the default cost for a shipping carrier for a shipping integration do the following:

  1. Open the configuration file ShippingConfig.txt.
  2. Find the section for the integration (by Integration ID).
  3. For each Method, in the “DefaultCost” field enter a default cost. This default cost will be applied to the shipment record when the shipping carrier/integration is selected in the Shipments window.
  4. Save the file.

Set a Default Markup Rate

To set the default markup for a shipping carrier for a shipping integration do the following:

  1. Open the configuration file ShippingConfig.txt.
  2. Find the section for the integration (by Integration ID).
  3. For each Method, in the “Markup” field enter a default markup. This markup will be applied to the shipment record when the shipping carrier/integration is selected in the Shipments window. Additionally, if the third party shipping software sends shipment cost to Printer’s Plan, this cost will be multiplied by the default markup to generate a shipping price.
  4. Save the file.

 

 

 

 

Related articles

Powered by Zendesk