This article provides an in depth explanation of ShipHawk’s rules engine and best practices. It includes instructions on creating and enabling rules and rule subtypes, and an extensive reference section that describes each rule criteria and actions.
...
Rule Criteria | Type | Description |
|---|---|---|
Any Rate Carrier Type | Carrier | A multi-picklist of carrier types like parcel, ltl and more. |
Backordered | Other | The item is backordered. (True/False) |
Carrier Name | Carrier | Name of the carrier. |
Carrier Service | Carrier | Name of the carrier service. |
Carrier Transit Time | Carrier | The estimated transit time for a carrier service. |
Carrier Type | Carrier | The carrier type: parcel or LTL. |
Channel Domain | Channel | The channel domain. |
Channel Name | Channel | The channel name. |
Destination Address 1 | Destination | Address listed in the destination address. |
Destination Address 2 | Destination | Address listed in the destination address. |
Destination Address Type | Destination | Residential, commercial or PO Box. |
Destination City | Destination | City listed in the destination address. |
Destination Company Name | Destination | Company name listed in the destination address. |
Destination Contact Name | Destination | Contact name listed in the destination address. |
Destination Country | Destination | Country listed in the destination address. |
Destination Email | Destination | Email associated with the contact person for the destination address. |
Destination State | Destination | State listed in the destination address. |
Destination Zip Code | Destination | Zip code listed in the destination address. |
Handling Unit Type | Item | Box, Pallet or Crate. |
Item Freight Class | Item | Freight class for the item. |
Item HS Code | Item | HS code for the item. |
Item Height | Item | Height measurement of the item. |
Item Length | Item | Length measurement of the item. |
Item NMFC | Item | NMFC code for the item. |
Item Quantity | Item | Quantity of the line item in the rating request. |
Item Type | Item | Unpacked, parcel, pallet. |
Item Value | Item | Value of the item. |
Item Volume | Item | Calculated volume of the item. |
Item Weight | Item | Weight of the item. |
Item Width | Item | Width measurement of the item. |
Order Source | Order | [DEPRECATED] |
Order Value | Order | Sum of all the item values in the order. |
Origin Address Type | Origin | Residential, commercial or PO Box. |
Origin Address 1 | Origin | Address listed in the origin address. |
Origin Address 2 | Origin | Address listed in the origin address. |
Origin City | Origin | City listed in the origin address. |
Origin Company Name | Origin | Contact company name listed in the origin address. |
Origin Contact Name | Origin | Contact name listed in the origin address. |
Origin Country | Origin | Country listed in the origin address. |
Origin Email | Origin | Email associated with the contact for the origin address. |
Origin State | Origin | State listed in the origin address. |
Origin Zip Code | Origin | Zip code listed in the origin address. |
Package Girth | Shipment | The girth of the package is two times the height of the package, plus two times the width of the package. |
Package Height | Shipment | The height of the package. |
Package Length | Shipment | The length of the package. |
Package Value | Shipment | Sum of all item values in a package. |
Package Weight | Shipment | Sum of all item weights in a package. |
Package Width | Shipment | The width of the package. |
Packed | Shipment | A flag to trigger rules when items are already packed. |
Product Category | Item | A product category. |
Product Subcategory | Item | A product subcategory. |
Prime | Other | The order is an Amazon Prime order. (True/False) |
Rate Source | Order | The source system of the rate request. |
Reference Number | Order | The order reference number. |
SKU | Item | SKU name of the items sent in the rating request. |
Shipment Value | Shipment | Sum of all item values in a shipment. |
Shipment Weight | Shipment | Sum of all item weights in a shipment. |
Tag | Other | The specified tag assigned to an order. |
Unpacked item ID | Item | The unpacked item type id (rarely used). |
Warehouse | Other | The warehouse code. |
...
Rating Rule Action | Type | Description |
|---|---|---|
Add Insurance for Declared value | Insurance and Accessorials | Adds insurances using the specified value. |
Add this accessorial for this Carrier | Insurance and Accessorials | Adds a carrier-specific accessorial. Example: Signature required. |
Apply this upfront accessorial for rating | Insurance and Accessorials | Include accessorial for getting rates. |
Combine USPS Priority Mail Types | Carrier | Combine USPS Priority Mail types (Priority Mail Express, Priority Mail) |
Create Table Rate | Rates | Allows users to create static table rates. |
Do Not Use this Carrier | Carrier | Excludes responses from specified carriers. |
Do Not Use this Carrier Service | Carrier | Excludes responses from specified carrier service. |
Do Not Use this Kind of Carrier | Carrier | Excludes responses from specified carrier type. |
Do Not Use this Service | Carrier | Excludes responses from specified service class. Example: Ground. |
Fixed Price for all Rates | Rates | Returns a fixed rate for all rate requests. |
Fixed Ship Rate for SKU | Rates | Returns a fixed rate for specified SKU. |
Free Shipping for Cheapest Rate | Rates | Returns $0 rates for the cheapest available carrier service. |
Free Shipping for this Product Category/Subcategory | Rates | Automatically specifies free shipping for selected product categories and subcategories. By usinig product categories and subcategories, rule creation is simplified: you do not have to enter specific SKUs that qualify for free shipping. |
Free Shipping for this SKU | Rates | Returns $0 rates for the specified SKUs. |
Markdown Rate by this Amount | Rates | Allows marking down each carrier’s rates by a specified amount. |
Markdown Rate by this Percent | Rates | Allows marking down each carrier's rates by specified percentage. |
Markdown Total Rate by this Percent | Rates | Allows marking down of total rate by a specified percentage when multiple carriers are returned for a single shipment. |
Markup Rate by this Amount | Rates | Allows marking up each carrier’s rates by a specified amount. |
Markup Rate by this Amount per Package | Rates | Allows marking up rate by a specified amount per package. For instance: markup shipping rates based on estimated labor and material costs for the shipment based on the size of the shipping container. This is useful especially if you are constructing shipping crates or other custom packaging, and therefore need a variable markup based on estimated cost. In the definition, you can specify Packing Material Cost per Sq/Ft Material Surface Area, Packing Labor Time per Sq/Ft Surface Area for Material, and Labor Rate Per Hour. |
Markup Rate by this Percent | Rates | Allows markup of each carrier rate by a specified percentage. |
Markup Total Rate by this Percent | Rates | Allows marking up of total rate by a specified percentage when multiple carriers are returned for a single shipment. |
Mask Carrier and Service | Carrier | Hides carrier name and service with service class. You can either use ShipHawk default service masking, or with the new functionality, you can custom define service level names, carrier mapping, and number of service levels. With custom Mask Carrier and Service, you can display your unique text and map only the specific carrier services based on your preferences. 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. Example: Ground. |
Prevent User from Booking Shipment | Other | Prevents users from being able to book a shipment. |
Return List Rates from Carrier | Rates | Return consumer (“list”) rates (as opposed to negotiated rates) for Basic (Ground International Economy), Preferred (Three-Day, Two-Day, International Priority), and Premium (Next Day). |
Return Standard In-Cart Rates for Hazmat Orders | Rates | Returns the standard in-cart rates for orders that include HAZMAT items. |
Return This Many of the Cheapest Rates | Rates | Rank all the returned rates from least to most expensive and display only the specified number of the least expensive options to the user. |
Return This Many of the Cheapest Rates | Rates | Return a specified number of the cheapest available rates. |
Round up rates to the cents | Rates | Automatically round up shipping rates to the nearest dollar or other increment, improving the aesthetics and usability of in-cart rate display. For example, when the Round Up Rates is enabled, a rate of $6.17 or $6.89 will automatically round up to $7.00. Alternatively, you can round to the nearest value, so $6.17 rounds to $6.00 and $6.89 rounds to $7.00. NOTE: when specifying the Value field for Round Up Rates, ShipHawk recommends values of $1.00 (the default) or $0.50. Be aware that if you use a value such as $0.99, $0.99 is added each time, starting from $1.99. For example, if the rate is $7.77, the rule would round up the rate to $7.92. |
Set Maximum Package Value | Other | Set the maximum package value that will be shipped. With this rule action, you can set the maximum package value so that you can limit the value of each package in a shipment. |
Set Maximum Package Weight for Multi-Item Packages | Other | With this rule action, you can set the maximum package weight so that you can limit the weight of each package in a shipment. When enabled, ShipHawk will limit the total weight of any package with shipping multiple items to the value set in the rule. Single items that are heavier than the threshold will be shipped individually. This can prevent fees and chargebacks from carriers and clients that have weight thresholds for packages. |
Use Cheapest Service that meets Delivery promise (in Days) | Carrier | Select this action to return the following in the shopping cart:
Note that Ground rates do not include Flat rate services such as FedEx OneRate. |
Use closest Warehouse for rating | Other | Limits response to closest warehouse. |
Use one of these Carrier Services | Carrier | Limits response to one or more specified carrier services. |
Use one of these Carrier Services | Carrier | Limits response to specified carrier services. |
Use one of these Carriers or 3PL accounts | Carrier | Limits response to the specified carrier or 3PL account. |
Use one of these Kinds of Carrier | Carrier | Limits response to one or more of the specified carrier types: LTL, Parcel, and so on. |
Use one of these Services | Carrier | Limits response to one or more specified carrier service classes. Example: Ground. |
Use one of these Services | Carrier | Limits response to specified carrier service class(es). Example: Ground. |
Use these Kinds of Carrier | Carrier | Limits response to the specified carrier type: LTL, Parcel, and so on. |
Use this Carrier Service | Carrier | Limits response to specified carrier service. |
Use this Packing Material | Other | Uses a specified packing material. |
Use this Warehouse for rating | Other | Uses specified warehouse as origin address for carrier rating. |
...