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.
...
The following section provides comprehensive definitions for the available rating rule actions in ShipHawk.
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. |
Free shipping for cheapest rate
Returns $0 rates for the cheapest available carrier service.
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 |
Allows markup of each carrier rate by a specified percentage.
Markup Total Rate by this Percent
Amount per Package | Rates | Allows marking up |
rate by a specified |
Mask Carrier and Service
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 youramount 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 |
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
Set the maximum package value that will be shipped.
Set packing markup based on estimated material and labor cost
.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. |
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 |
Use one of these Services
Limits response to one or more specified carrier service classes. Example: Ground.
Use the ‘Fastest Rate’
Chooses the carrier service with the soonest estimated delivery date.
Use the Best Ground Rate, excluding Flat Rate Services
Limit response to thee best ground rate service (excluding flat rate services)
Use this Carrier
Limit response to specified carrier.
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 |
Uses a specified packing material.
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. |
Shipping policy actions
The following section provides comprehensive definitions for the available shipping policy actions in ShipHawk.
Shipping Policy Action | Description |
|---|---|
Add Insurance for Declared value | Adds insurances using the specified value. |
Add tags | Adds tags to the order. |
Add this Accessorial | Adds a specified accessorial to an order. |
Add this Accessorial for this Carrier | Adds a carrier-specific accessorial. Example: Signature required. |
Assign this Warehouse to Order Line item | Assigns a warehouse to fulfill certain order line items. |
Assign this Warehouse to Process Orders | Assigns a particular warehouse to fulfill an entire order. |
Do Not Import This Order | Excludes orders from synchronizing to ShipHawk. Example: drop-ship orders. |
Do Not Use these Carrier Services | Excludes responses from specified carrier services. |
Do Not Use these Carriers | Excludes responses from specified carriers. |
Do Not Use these Services | Excludes responses from specified service classes. Example: Ground. |
Exclude this SKU from Order | Excludes specified SKUs from orders. |
Include a Return Label | Includes a return label in specified orders. |
Prevent User from Booking Shipment | Prevents users from being able to book a shipment. When a shipping policy with this action is active, when users try to book the shipment, the following error message is displayed: “An active shipping policy restricts the booking of this shipment. Contact your ShipHawk administrator or check your shipping policies.” This shipping policy is not applied before or during proposed shipment generation (as with most shipping policies); rather, this is applied only during the time of proposed shipment booking. This action is useful if you need a mechanism to hold or restrict the fulfillment of orders until the orders are approved (by a Financial Controller, for example). |
Put this SKUs into new Order | Separates specified SKUs into a new order. |
Set Destination Address Type | Sets a destination address type for specified orders. |
Set Dimensions and Weight | Set the dimensions and weight for a specified order. |
Set Maximum Package Value | Set the maximum package value that will be shipped. |
Set a 3rd Party Carrier Account | Use a 3rd party carrier account for this order. |
Set duties and taxes billing | Specify duties and taxes billing for a given order. The billed party can be set to either Senderor Recipient (collect). When a rule is applied to an order, it overrides the account-level setting. |
Set shipment billing details | Set shipment billing details for Small Parcel or LTL, and for Sender, or Recipient, or Third Party, or Consignee Collect. Enter Lookup Address, Zip Code, and Country. |
Set external shipment fields | Automates the selection of the External Shipment checkbox and related fields. This provides improved automation if you are using External Shipments while reducing shipment processing time and the possibility of mistakes related to manual entry. Note that multiple rules might be needed for some fields (such as Markup). |
Set external shipping price markup/markdown | Markup or markdown shipments in ShipHawk automatically. A shipping policy with this action can markup or markdown shipments by either a flat dollar amount, or percentage: any proposed shipment that meets the rule criteria will have a markup automatically applied to it. |
Use Alternate Return Address | Lists an alternate return address (not the origin address) for specified orders. |
Use Carrier Container | Use a carrier branded packing material for this order. |
Use Cheapest Service that meets Delivery promise (in Days) | Limits response to carrier services that will deliver in a specified number of days or less. |
Use EEI Exemption Code | Use a specified EEI exemption code for this order. |
Use Material Container | Use a specific material container for this order. |
Use Package Preset | Applies an existing package preset to specified orders. |
Use Specific Packing Slip | Selects the specified packing slip for a proposed shipment. |
Use Specific Packing Slip only for Proposed Shipment | Assigns a specific packing slip template to proposed shipments that fulfill the criteria. |
Use the best ground rate, excluding Flat Rate Services | Do not use: will be deprecated. (Uses the cheapest ground rate available from all carriers. Ignores flat rate services.) |
Use the Cheapest Rate of these Carriers | Rank all the returned rates from least to most expensive and display only the least expensive options to the user for the specified carriers. |
Use this Carrier | Limits response to specified carrier. |
Use this Carrier Service | Limits response to specified carrier service. |
Use this Carrier or 3PL account | Limits response to the specified carrier or 3PL account. |
Use this Carton Label | Select the specified carton label for a proposed shipment. |
Use this Kind of Carrier | Limits response to the specified carrier type: LTL, Parcel, and so on. Filters out rate responses from carriers that do not match Carrier Kind/Type. NOTE: If no rates are available from this “Kind of Carrier”, ShipHawk will generate a generic shipment. It will not force a pallet item to ship Small Parcel. |
Use this Packing Material | Uses a specified packing material for orders. |
Use this Pallet Label | Select the specified pallet label for a proposed shipment. |
Use this Service | Limits response to specified carrier service class. Example: Ground. |
Use this Shipper’s Letter of Instruction template | Use this action to create a shipping policy rule that allows users to select one of the available Shipper’s Letter of Instruction (SLI) templates to be applied to an order based on the rule’s criteria. |
Rating rule criteria
The following section provides comprehensive definitions for the available rating rule criteria in ShipHawk.
Rating Rule Criteria | Description |
|---|---|
Any Rate Carrier Type | A multi-picklist of carrier types like parcel, ltl and more. |
Backordered | The item is backordered. (True/False) |
Carrier Name | Name of the carrier. |
Carrier Service | Name of the carrier service. |
Carrier Transit Time | The estimated transit time for a carrier service. |
Carrier Type | The carrier type: parcel or LTL. |
Channel Domain | The channel domain. |
Channel Name | The channel name. |
Destination Address 1 | Address listed in the destination address. |
Destination Address 2 | Address listed in the destination address. |
Destination Address Type | Residential, commercial or PO Box. |
Destination City | City listed in the destination address. |
Destination Company Name | Company name listed in the destination address. |
Destination Contact Name | Contact name listed in the destination address. |
Destination Country | Country listed in the destination address. |
Destination Email | Email associated with the contact person for the destination address. |
Destination State | State listed in the destination address. |
Destination Zip Code | Zip code listed in the destination address. |
Handling Unit Type | Box, Pallet or Crate. |
Item Freight Class | Freight class for the item. |
Item HS Code | HS code for the item. |
Item Height | Height measurement of the item. |
Item Length | Length measurement of the item. |
Item NMFC | NMFC code for the item. |
Item Quantity | Quantity of the line item in the rating request. |
Item Type | Unpacked, parcel, pallet. |
Item Value | Value of the item. |
Item Volume | Calculated volume of the item. |
Item Weight | Weight of the item. |
Item Width | Width measurement of the item. |
Order Source | [DEPRECATED] |
Order Value | Sum of all the item values in the order. |
Origin Address type | Residential, commercial or PO Box. |
Origin Address 1 | Address listed in the origin address. |
Origin Address 2 | Address listed in the origin address. |
Origin City | City listed in the origin address. |
Origin Company Name | Contact company name listed in the origin address. |
Origin Contact Name | Contact name listed in the origin address. |
Origin Country | Country listed in the origin address. |
Origin Email | Email associated with the contact for the origin address. |
Origin State | State listed in the origin address. |
Origin Zip Code | Zip code listed in the origin address. |
Package Value | Sum of all item values in a package. |
Package Weight | Sum of all item weights in a package. |
Packed | A flag to trigger rules when items are already packed. |
Prime | The order is an Amazon Prime order. (True/False) |
Rate Source | The source system of the rate request. |
Reference Number | The order reference number. |
SKU | SKU name of the items sent in the rating request. |
Shipment Value | Sum of all item values in a shipment. |
Shipment Weight | Sum of all item weights in a shipment. |
Tag | The specified tag assigned to an order. |
Unpacked item ID | The unpacked item type id (rarely used). |
Warehouse | The warehouse code. |
Shipping policy criteria
The following section provides comprehensive definitions for the available shipping policy criteria in ShipHawk.
Shipping Policy Criteria | Description |
|---|---|
Any Rate Carrier Type | A multi-picklist of carrier types like parcel, LTL, and more. |
Carrier Service | Name of the carrier. |
Carrier Transit Time | The carrier type: parcel or LTL. |
Carrier Type | Name of the carrier service. |
Channel Domain | The channel domain. |
Channel Name | The channel name. |
Destination Address 1 | Address listed in the destination address. |
Destination Address 2 | Address listed in the destination address. |
Destination Address Type | Residential, commercial or PO Box. |
Destination City | City listed in the destination address. |
Destination Company Name | Company name listed in the destination address. |
Destination Contact Name | Contact name listed in the destination address. |
Destination Country | Country listed in the destination address. |
Destination Email | Email associated with the contact person for the destination address. |
Destination State | State listed in the destination address. |
Destination Zip Code | Zip code listed in the destination address. |
Handling Unit Type | Box, Pallet or Crate. |
Item Freight Class | Freight class for the item. |
Item HS Code | HS code for the item. |
Item Height | Height measurement of the item. |
Item Length | Length measurement of the item. |
Item NMFC | NMFC code for the item. |
Item Quantity | Quantity of the line item in the order. |
Item Ship Individually | The item is marked as Ships Individually. |
Item Type | Unpacked, parcel, pallet. |
Item Value | Value of the item. |
Item Volume | Calculated volume of the item. |
Item Weight | Weight of the item. |
Item Width | Width measurement of the item. |
Order Fulfillment Retailer | [DEPRECATED] |
Order Number | The ShipHawk order number. |
Order Source | The source of the order. |
Order Source System | The source system of the order. |
Order Source System Domain | The source domain of the order. |
Order Source System Status | The status of the order in the source system. |
Order Total Price | The total price of an order. |
Order Value | The total value of the items in an order. |
Origin Address 1 | Address listed in the origin address. |
Origin Address 2 | Address listed in the origin address. |
Origin Address Type | Residential, commercial or PO Box. |
Origin City | City listed in the origin address. |
Origin Company Name | Contact company name listed in the origin address. |
Origin Contact Name | Contact name listed in the origin address. |
Origin Country | Country listed in the origin address. |
Origin Email | Email associated with the contact for the origin address. |
Origin State | State listed in the origin address. |
Origin Zip Code | Zip code listed in the origin address. |
Package Value | The total value of the items in a package. |
Packed | A flag to trigger rules when items are already packed. |
Prime | The order is an Amazon Prime order. (True/False) |
Product Category | Identifies specific product category of items. |
Product Subcategory | Identifies specific product subcategory of items. |
Reference Number | The reference number for the order. |
Requested Shipping Details | The estimated transit time for a carrier service. |
SKU | SKU names of the items in the order. |
Shipment Value | The total value of the items in a shipment. |
Single Bin Number | A BIN Number if present. |
Tag | The tag associated with an order. |
Total Items Weight | The total weight of the items. |
Unpacked Item ID | The unpacked item type id (rarely used). |
Warehouse | Warehouse assigned. |