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.
...
Rating Rule Action | Description |
|---|---|
Add Insurance for Declared value | Adds insurances using the specified value. |
Add this accessorial for this Carrier | Adds a carrier-specific accessorial. Example: Signature required. |
Apply this upfront accessorial for rating | Include accessorial for getting rates. |
Combine USPS Priority Mail Types | Combine USPS Priority Mail types (Priority Mail Express, Priority Mail) |
Create Table Rate | Allows users to create static table rates. |
Do Not Use these Carrier Services | Excludes responses from specified carrier service. |
Do Not Use these Carriers | Excludes responses from specified carriers. |
Do Not Use these Kinds of Carriers | Excludes responses from specified carrier type. |
Do Not Use these Services | Excludes responses from specified service class. Example: Ground. |
Fixed Price for all Rates | Returns a fixed rate for all rate requests. |
Fixed Ship Rate for SKU | Returns a fixed rate for specified SKU. |
Free Shipping for this Product Category/Subcategory | 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 | 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 | Allows marking down each carrier’s rates by a specified amount. |
Markdown Rate by this Percent | Allows marking down each carrier's rates by specified percentage. |
Markdown Total Rate by this Percent | Allows marking down of total rate by a specified percentage when multiple carriers are returned for a single shipment. |
Markup Rate by this Amount | Allows marking up each carrier’s rates by a specified amount. |
Markup Rate by this Percent | Allows markup of each carrier rate by a specified percentage. |
Markup Total Rate by this Percent | Allows marking up of total rate by a specified percentage when multiple carriers are returned for a single shipment. |
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 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 | Prevents users from being able to book a shipment. |
Return List Rates from Carrier | 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 This Many of the Cheapest 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. |
Round up rates to the cents | 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 | Set the maximum package value that will be shipped. |
Set packing markup based on estimated material and labor cost | 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. |
Use Cheapest Service that meets Delivery promise (in Days) | 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 | Limits response to closest warehouse. |
Use one of these Carrier Services | Limits response to one or more specified carrier services. |
Use one of these Kinds of Carrier | Limits response to one or more of the specified carrier types: LTL, Parcel, and so on. |
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. |
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 Kind of Carrier | Limits response to the specified carrier type: LTL, Parcel, and so on. |
Use this Packing Material | Uses a specified packing material. |
Use this Service | Limits response to specified carrier service class. Example: Ground. |
Use this Warehouse for rating | Uses specified warehouse as origin address for carrier rating. |
...
Rating Rule Criteria | Description | ||
|---|---|---|---|
Any rate carrier typeRate Carrier Type | A multi-picklist of carrier types like parcel, ltl and more. | ||
Backordered | The item is backordered. (True/False) | ||
Carrier nameName | Name of the carrier. | ||
Carrier serviceService | Name of the carrier service. | ||
Carrier transit timeTransit Time | The estimated transit time for a carrier service. | ||
Carrier typeType | The carrier type: parcel or LTL. | ||
Channel domainDomain | The channel domain. | ||
Channel nameName | The channel name. | ||
Destination address type | Residential, commercial or PO Box. | Destination address1Address 1 | Address listed in the destination address. |
Destination address2Address 2 | Address listed in the destination address. | ||
Destination Address Type | Residential, commercial or PO Box. | ||
Destination cityCity | City listed in the destination address. | ||
Destination company nameCompany Name | Company name listed in the destination address. | ||
Destination contact nameContact Name | Contact name listed in the destination address. | ||
Destination countryCountry | Country listed in the destination address. | ||
Destination emailEmail | Email associated with the contact person for the destination address. | ||
Destination stateState | State listed in the destination address. | ||
Destination zip codeZip Code | Zip code listed in the destination address. | ||
Handling unit typeUnit Type | Box, Pallet or Crate. | ||
Is backordered | The item is backordered. (True/False) | ||
Is prime | The order is an Amazon Prime order. (True/False) | ||
Item freight classItem Freight Class | Freight class for the item. | ||
Item heightHeight measurement of HS Code | HS code for the item. | ||
Item hs codeHS code for Height | Height measurement of the item. | ||
Item lengthLength | Length measurement of the item. | ||
Item nmfcNMFC | NMFC code for the item. | ||
Item quantityQuantity | Quantity of the line item in the rating request. | ||
Item typeType | Unpacked, parcel, pallet. | ||
Item valueValue | Value of the item. | ||
Item volumeVolume | Calculated volume of the item. | ||
Item weightWeight | Weight of the item. | ||
Item widthWidth | Width measurement of the item. | ||
Order sourceSource | [DEPRECATED] | ||
Order valueValue | Sum of all the item values in the order. | ||
Origin address Address type | Residential, commercial or PO Box. | ||
Origin address1Address 1 | Address listed in the origin address. | ||
Origin address2Address 2 | Address listed in the origin address. | ||
Origin cityCity | City listed in the origin address. | ||
Origin company nameCompany Name | Contact company name listed in the origin address. | ||
Origin contact nameContact Name | Contact name listed in the origin address. | ||
Origin countryCountry | Country listed in the origin address. | ||
Origin emailEmail | Email associated with the contact for the origin address. | ||
Origin stateState | State listed in the origin address. | ||
Origin zip codeZip Code | Zip code listed in the origin address. | ||
Package valueValue | Sum of all item values in a package. | ||
Package weightWeight | 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 sourceSource | The source system of the rate request. | ||
Reference numberNumber | The order reference number. | ||
SKU | SKU name of the items sent in the rating request. | ||
Shipment valueValue | Sum of all item values in a shipment. | ||
Shipment weightWeight | Sum of all item weights in a shipment. | Sku | SKU name of the items sent in the rating request. |
Tag | The specified tag assigned to an order. | ||
Unpacked item idID | The unpacked item type id (rarely used). | ||
Warehouse | The warehouse code. |
...