Automation Rules Criteria and Actions

Here you will find a reference of all the available criteria and actions for ShipStation Automation Rules.

Available Criteria

Criteria

Description

# of Line Items

The number of unique line items in the order - not to be confused with Total Quantity.

Address Line 1

The first line of the address.

Address Line 2

The second line of the address.

Address Verified

The address verification system processed the address and returned a Verified, Warning, or Error status.

Amount Paid

The amount paid by the customer.

Assigned User

The specific user assigned to this order.

Buyer ID

Customer identifier imported from the marketplace - typically the username or email address.

Customer

The name of the customer (formerly Buyer Name)

Carrier

Carrier and/or Postage Provider

City

Ship To city

Country

Ship To country

Custom Field 1

Refers to the Custom Fields within an order. Data can equal, contain, start with, end with, or be blank

Custom Field 2

Custom Field 3

Date Paid

The date the payment was made

Gift Order

Is the This is a gift option checked in the order?

Internal Notes

Data can equal, contain, start with, end with, or be blank

Item Name

The name of the order item.

Important

Automation Rules using Item Name as criteria will not apply to orders that have more than one line item in the order. Because of this, we recommend adding tags to your product records and using the product tag as automation criteria.

Item SKU

The SKU of the order item.

Important

Automation Rules using Item SKU as criteria will not apply to orders that have more than one line item in the order. Because of this, we recommend adding tags to your product records and using the product tag as automation criteria.

Marketplace

The marketplace the order imports from

Notes to the Buyer

Refers to the Notes fields within an order. Data can equal, contain, start with, end with, or be blank

Notes from Buyer

Order #

The Order Number as displayed in ShipStation

Order Date

The date the order was placed

Order Subtotal

The cost of the order prior to calculating customer’s shipping charge and taxes

Order Tags

Tags that have been added to the order

Order Total

The cost of the order, including shipping fees and taxes

Package

The package type selected for the order

Payment Method

How was this order paid for? Credit card, C.O.D., etc

This criterion is only available in ShipStation Legacy.

Postal Code

Ship To postal code

Recipient Company

Ship To company name

Recipient Name

Ship To recipient name

Requested Service (Mapped)

The carrier/service/package the requested service has been mapped to in ShipStation

Requested Service (Marketplace Value)

The carrier/service/package that the customer selected for the order during checkout

Residential / Commercial

Address has been verified as residential or commercial

Ship By Date

The already-defined Ship By Date from the marketplace

Shipping Account

Which Shipping Account is defined - My Account, Third Party, or Recipient?

Shipping Paid

The shipping cost paid by the customer

Source

The original source of the order when importing orders from a Shopping Cart, Inventory Solution, etc.

State

Ship To state

Store

The store the order imported from

Tax Paid

The tax amount paid by the customer

Total Quantity

Total number of items in order

Total Weight

Total order weight

USPS Zone

USPS Zone based on Ship From and Recipient postal codes

Ship From Location

The defined Ship From location

Warehouse Location

The Warehouse Location outlined in the product defaults for the order item.

Important

Automation Rules using Warehouse Location as criteria will not apply to orders that have more than one line item in the order. Because of this, we recommend adding tags to your product records and using the product tag as automation criteria.

Notes about Automation Criteria

The table below clarifies the unique needs of certain Automation Criteria or Criteria types.

Automation Criteria

Notes

Address Verified

There is not currently a way to select multiple values for this criterion in a single line.

If you want automation to apply when an address is verified as a Warning or an Error, you must have two automation rules - one for each value.

Item Specific

Automation rules using the Item NameItem SKU, and Warehouse Location criteria options will only apply to orders containing a single unique line item (the quantity of that line item does not matter).

Even if every product in the order matches the criteria, the automation rule will be skipped if there is more than one unique line item.

If you need automation based on an ordered product, regardless of other products in the order, create a tag for the product, tag the product record in ShipStation with that tag, and use the tag as the criteria instead.

See the FAQ article, How do I create Automation Rules for Multi-product Orders? for more details.

Order Tags

If you select multiple tags as the value in a single criteria line, then the rule will apply when any of the selected tags are on the order.

If you only want the rule to apply if all tags are present, each tag should have its own criteria line.

Available Automation Actions

Action

Description

Add an Internal Note…

Adds notes to the Internal field in the order.

Add Note to the Buyer…

Adds text to the Notes to Buyer field in the order.

Adjust the Order Weight…

Adds a specific amount to the order weight based on what you select in the rule setup.

Assign to a user…

Assigns the order to a designated user in the ShipStation account.

Bill Int’l Duties to Payor of Shipping Charges

Marks the duties of the order to be billed to the shipper instead of the recipient (check with your carrier to find out how they will bill those charges).

Charge Shipping to 3rd Party…

Designates a third-party account as the payor of shipping charges (this option requires the shipping service to have already been applied to the order).

Charge Shipping to My Account…

Designates your pre-selected shipping account as the payor of the shipping charges.

Collect Payment on Delivery (C.O.D.)...

Applies the Cash On Delivery (C.O.D.) option to the order (not supported by all carriers).

Create an Alert…

Creates an order alert with customized information.

Do Not Notify Marketplace of Shipment

Prevents ShipStation from sending the Marketplace Notification.

Do Not Prepay Postage (Endicia Only)

Automatically selects Do Not Prepay Postage from Other Shipping Options for the matched order.

Don’t Import the Order

Removes the order from ShipStation and prevents future imports of the same order from that selling channel connection.

Enable Saturday Delivery (UPS / FedEx)

Automatically selects Saturday Delivery from Other Shipping Options for the matched order.

Enable Shipper Release (UPS only)

Automatically selects Driver may release package without signature in Other Shipping Options for the matched order.

Hold the Order for…

Places matched order on hold for a specific number of days.

Hold Until…

Places match orders on hold until a specific date.

Include a Return Label with the Outbound Label

Generates a return label when the outbound label is created.

Insure the Package…

Automatically assigns a specific insurance provider to the matched order.

Mark Shipment(s) as “Non-Machinable”

Automatically marks the matched order as Non-Machinable (typically results in a surcharge).

Request Confirmation…

Assigns a specific confirmation type to the order.

Send an email…

Sends an email to designated email addresses when the rule runs.

When in trial, you must contact the ShipStation Support team to have this action enabled for your account.

Set Carrier/Service/Package…

Assigns a Carrier/Service/Package to the matched order.

Set Custom Field 1…

Adds a note to Custom Field 1.

Set Custom Field 2…

Adds a note to Custom Field 2.

Set Custom Field 3…

Adds a note to Custom Field 3.

Set Customs Content Type…

Assigns the content type of your order’s customs declarations.

Set Declaration Statement (FedEx only)

Sets declaration statement that will be used on customs documents for FedEx international shipment.

Set Fulfillment Provider…

Selects the Fulfillment Provider and offers the option to automatically send the order to that provider.

Set International Non-Delivery…

Selects the action that should be taken when an international shipment cannot be delivered.

Set Package Dimensions…

Sets the length, width, and height of your order.

Set Ship By Date

Sets the Ship By Date in your Order.

Set Ship From Location…

Sets the Ship From Location in your order.

Set Tax Identifiers

Adds a Tax ID number from your International Settings to your customs declaration.

Set the Dry Ice Weight (UPS / FedEx)

Sets the Dry Ice Weight in the order. Does not alter the order's weight.

Set the Order as Containing Alcohol (FedEx)

Automatically selects This order includes alcohol in Other Shipping Options for the matched order.

Set the Order as Containing Dry Ice (UPS / FedEx)

Selects that the order includes dry ice, but does not set the weight.

Set the Total Order Weight…

Defines the total weight of the order (different from Adjust Order Weight).

Show Postage Paid on the Label

Displays the price of the postage on the label for the matched order.

Stop Processing Rules for the Order

Stops any automation rules that follow this rule from running on that order.

Use a specific Packing Slip…

Assigns a selected packing slip to the matched order.

Use email template for Delivery Notification…

Assigns a selected email delivery template to the matched order.

Use email template for Shipment Notification…

Assigns a selected email shipment confirmation template to the matched order.

Notes about Automation Actions

The table below lists specific notes around certain Automation actions or action types.

Action

Notes

Note Actions

If your store sends Internal Note, Custom Field #1, Custom Field #2, or Custom Field #3 to ShipStation, an action that sets the same note field will override the note imported from the store.

However, if the store refreshes and includes the same order information, ShipStation will update the order to match the store. In this situation, it's best to update these notes directly in the store and let it flow into ShipStation via a store refresh.

Adjust Weight:

This action will only apply to an order once. It will not apply to an order again even if you reprocess automation rules.

Charge Shipping to My Account

Only use this action if you have multiple accounts connected to ShipStation for a single carrier, like two FedEx accounts. When used, this action will allow you to set which account should be used to create the label.

If a shipping service is already selected for the order but does not match the services provided by the carrier account set by this action, ShipStation will clear the order's shipping service.

If you only have a single account connected for each carrier, this action is not necessary.

Don't Import the Order:

Be very careful with this action!

If this action applies to an order, the order will be set to an inactive status in our database and removed from view and all reporting in ShipStation.

Once this action applies to an order it cannot be undone. It locks the order out of ShipStation completely. Even if you delete the rule, re-importing the store's orders or using the Reprocess Automation Rules button will have no effect.

Send an Email

This action is not enabled for trial users. If you need to use this automation action, please contact the ShipStation Support team and an agent can enable it for your account.

This action will only apply to an order once. It will not apply to an order again even if you reprocess automation rules.

When setting this action, you can either send the email to a specific email address or use the customer or store's email address.

This action sends the email immediately when the order imports. If you want to adjust the shipping confirmation email ShipStation sends at the time of label creation, use the Use email template for Shipment Notification…  action instead.

Set Fulfillment Provider

This action will set the fulfillment provider for the order. This action also gives the option for ShipStation to automatically send a fulfillment request to the provider upon import of the order.

The portion of the action that sets the fulfillment provider will apply again if you reprocess automation rules, but the action that automatically sends the request will not.

If you encounter an error when sending the automatic fulfillment request, ShipStation will retain the order in the Awaiting Shipment status. You will then need to use the manual Send Fulfillment action to request fulfillment again.