ShipHawk Guide
How to Mask Carrier and Service to External Systems
This article explains how to deploy a Mask Carrier and Service rule to your external systems.
Mask Carrier and Service allows you to display rates in an external system like Shopify that hide the specific carrier and service returned in ShipHawk. To Mask your Carrier and Service you need to create a rating rule.
With the Mask Carrier and Service rating rule, you can either use ShipHawk default service masking, or you can define custom service level names, carrier mapping, and number of service levels.
The custom Mask Carrier and Service enables you to display your unique text and map only the specific carrier services based on your preferences.
This article covers the following topics:
Default Mask and Carrier Service Rating Rule
The default Mask Carrier and Service rule action returns the lowest shipping cost based on four predefined service levels, including Standard Ground, Standard Three-Day, Standard Two-Day, and Standard Next Day, that are mapped to all carrier services.
This rule action will group all available carrier rates into 4 distinct transit time groups and return the cheapest carrier service for each transit time to any external rating output (i.e. an integration like Shopify). Buyers will not be able to see exactly which carrier or service is returned. The 4 groups are the following.
Standard Ground
Ex: FedEx Ground/Home Delivery, UPS SurePost, USPS First Class MailStandard Three-Day
Ex: UPS Three-Day Select, FedEx Express Saver, USPS PB Priority MailStandard Two-Day
Ex: UPS Second Day Air, FedEx 2 DayStandard Next Day
Ex: FedEx Priority Overnight, UPS Next Day Air, USPS Priority Mail Express
An example of how this appears in the buyer’s shopping cart is shown below.
How to Create a Mask Carrier and Service Rule
To create a rule to Mask Carrier and Service:
Log into your ShipHawk account
Click on the Settings Cog in the top right > Rules
Select Actions > Create New Rule. The Rule Configuration page will appear.
In the Rule Configuration Page, You will need to name your rule and choose the rule type. Set Rule Type to“Rating Rule”.
Next, under Rule Actions, select “Mask Carrier and Service”:
Click Save.
This rule will apply to all external systems where rates from ShipHawk are displayed.
How do I Configure my rule to only work in a specific External System like NetSuite or Shopify?
If you want to create a rating rule that applies to a specific external system instead of all external systems, a rule criteria must be set. To configure your rating rule to only Mask Carrier and Services for a specific external system, select “Rate source” under Rule Criteria. Then, set your operator to “contains”.
You will need to set the source name of the external system you want to Mask Carrier and Service to. For this example we are using “shopify” as our Rate Source. For NetSuite you can use the Rate Source name “net_suite”.
If you want your Mask Carrier and Service rating rule to only apply to NetSuite, set your Rule Criteria to Rate source “contains” net_suite.
Custom Mask Carrier and Service Rating Rule
The custom Mask Carrier and Service enables you to display your unique text and map only the specific carrier services based on your preferences.
When defining a rule action, click +Add Service:
You can now specify the custom Service Description Mask, Service Details, and Map to Carrier Service or Standard SH Service:
NOTE: SH = ShipHawk.
For example, to offer delivery of your product by “Tomorrow”, define the following, which directs ShipHawk to use FedEx Priority Overnight:
Contact Technical Support
© ShipHawk 2024. All Rights Reserved.