Create New Rule (Screen Reference)

[ 1 RATE SOURCE ] [ 2 RULE APPLICATION ] [ 3 RULE CRITERIA ] [ 3.1 Rating Rule Criteria ] [ 3.2 Shipping Policy Criteria ] [ 4 RULE ACTIONS ] [ 4.1 Rating Rule Actions ] [ 4.2 Shipping Policy Actions ]

To create a new rule, fill out the fields on this page and click Create at the bottom of the page.

Rule Name – enter a name of the rule that briefly summarizes the purpose of the rule.

Rule Type – select the type of rule as either Rating or Shipping Policy.

Rating Rules are used to influence the Rates that end-users or customers see when making a purchase. This is often used in an online shopping cart or on a sales order entry form in an ERP.

Shipping Policies are used to include how Orders are set up for fulfillment, like the carrier, service, or warehouse to ship an order from.

Enabled – select whether the rule is currently active in your system.

Is Backup Rate? – select whether the rule applies to backup rate. Backup rates are a special type of rating rule that uses static or percentage-based rule action that can be used as a fallback in the event that a carrier service is temporarily unavailable.

Rules allow users to customize rating and shipping services in the ShipHawk platform. The user is responsible for validating all rules to verify that the desired Rates and Shipping Services are applied.

RATE SOURCE

Select the rate source:

API – apply rule to your shopping cart or to any external rates.
Web Portal – apply rule when rating from within the web portal.
Any

RULE APPLICATION

Select one of the following:

Apply this rule to all rate requests and orders
Only apply this rule under specific conditions

RULE CRITERIA

If Only apply this rule under specific conditions is selected, this section is displayed.

The criteria options can vary, depending on whether the Rule Type is set to Rating or Shipping Policy.

Rating Rule Criteria

Rating Rule Criteria	Description

Rating Rule Criteria	Description
Any rate carrier type	A multi-picklist of carrier types like parcel, ltl and more.
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 type	Residential, commercial or PO Box.
Destination address1	Address listed in the destination address.
Destination address2	Address listed in the destination address.
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.
Is backordered	The item is backordered. (True/False)
Is prime	The order is an Amazon Prime order. (True/False)
Item freight class	Freight class for the item.
Item height	Height measurement of the item.
Item hs code	HS code for 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 address1	Address listed in the origin address.
Origin address2	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.
Rate source	The source system of the rate request.
Reference number	The order reference number.
Shipment value	Sum of all item values in a shipment.
Shipment weight	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 id	The unpacked item type id (rarely used).
Warehouse	The warehouse code.

Shipping Policy Criteria

Shipping Policy Criteria	Description

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 type	Residential, commercial or PO Box.
Destination address1	Address listed in the destination address.
Destination address2	Address listed in the destination address.
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.
Is prime	The order is an Amazon Prime order. (True/False)
Item freight class	Freight class for the item.
Item height	Height measurement of the item.
Item hs code	HS code for 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 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 fulfillment retailer	[DEPRECATED]
Order number	The ShipHawk order number.
Order source	The source system of the order.
Order total price	The total price of an order.
Order value	The total value of the items in an order.
Origin address type	Residential, commercial or PO Box.
Origin address1	Address listed in the origin address.
Origin address2	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	The total value of the items in a package.
Packed	A flag to trigger rules when items are already packed.
Reference number	The reference number for the order.
Requested shipping details	The estimated transit time for a carrier service.
Shipment value	The total value of the items in a shipment.
Single Bin number	A BIN Number if present.
Sku	SKU names of the items in the order.
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.

RULE ACTIONS

A rule consists of one or more rule actions. Actions are applied to all items within an order.

The drop-down rule action options vary, depending on whether the Rule Type is set to Rating or Shipping Policy.

Rating Rule Actions

From the drop-down, select from the following actions for Rating rules:

Rating Rule Action	Description

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 Service Days Filter	Limits response to carrier services that will deliver in a specified number of days or less. This rule action will choose the cheapest carrier that can meet the Service Days (days from pickup to delivery) specified for this Action. ShipHawk will only return Carrier Services that can meet the transit time specified. Instead of forcing all shipments to go with a Two-Day or Next-Day service, this special action helps users downgrade to a lower service level (such as Ground) to save money while meeting the customer’s requested shipping speed. Example: An eCommerce business wants a global delivery promise of 2-day shipping. They could just use FedEx 2-Day to offer guaranteed 2-day shipping to all customers. But FedEx Ground can deliver in 1 or 2 days in many locations depending on where the product is shipping from. The action lets you optimize your use of FedEx services to meet the customer commitment while not overpaying for shipping. If a rule is set up to apply service days filter of 2 days and Fedex Ground returns a transit of two days for the particular shipment, ShipHawk will include it in the rate response even though FedEx Ground is a 5-day guaranteed service.
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 this Carrier	Excludes responses from specified carriers.
Do Not Use this Carrier Service	Excludes responses from specified carrier service.
Do Not Use this Kind of Carrier	Excludes responses from specified carrier type.
Do Not Use this Service	Excludes responses from specified service class. Example: Ground.
Fixed Price for all Rates	Returns a fixed rate for all rate requests.
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 such as “Ground.” This rule action will group all available carrier rates into four distinct transit time groups and return the cheapest carrier service for each transit time to any external rating output (for example, an integration like Shopify). Buyers will not be able to see exactly which carrier or service is returned. The four groups are the following. Standard Ground Standard Three-Day Standard Two-Day Standard Next Day Here’s an example of how this appears in the buyer’s shopping cart:
Restrict Book Shipment	Prevents users from being able to book a shipment.
Return Consumer Rates	Return carrier list rates (as opposed to negotiated rates).
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.
Set Maximum Package Value	Set the maximum package value that will be shipped.
Use the ‘Best Rate’	Select this action to return the following in the shopping cart: The cheapest Ground rate The cheapest 2 or 3 day Ground rate The cheapest Next Day Ground rate Note that Ground rates do not include Flat rate services such as FedEx OneRate.
Use the ‘Fastest Rate’	Chooses the carrier service with the soonest estimated delivery date.
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.

Shipping Policy Actions

Shipping Policy Action	Description

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.
Apply Service Days Filter	Limits response to carrier services that will deliver in a specified number of days or less.
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 this Carrier	Excludes responses from specified carriers.
Do Not Use this Carrier Service	Excludes responses from specified carrier service.
Do Not Use this Service	Excludes responses from specified service class. Example: Ground.
Exclude this SKU from Order	Excludes specified SKUs from orders.
Include a Return Label	Includes a return label in specified orders.
Put this SKUs into new Order	Separates specified SKUs into a new order.
Restrict Book 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).
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 Sender or Recipient (collect). When a rule is applied to an order, it overrides the account-level setting.
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 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 Rate’	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.
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.