Here you will find a reference for all the available criteria and actions for ShipStation Automation Rules.
Criteria |
Description |
---|---|
Address Verified |
The address verification system processed the address and returned a Verified, Warning, or Error status. |
Address Line 1 |
The first line of the address. |
Address Line 2 |
The second line of the address. |
Amount Paid |
The amount paid by the customer. |
Assigned User |
The specific user assigned to this order. |
Brand |
The Company Name associated with the order from your client. |
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 |
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 |
|
Country |
Ship To country TipWhen you create a rule to apply to domestic shipments the criteria field for the rule will automatically adjust to |
Date Paid |
The date the payment was made |
Deliver by Date |
Deliver By Date helps a merchant decide which service or carrier to use to ensure the delivery time is met. |
Gift Order |
Is the This is a gift option checked in the order? |
International Order |
Any order with a Ship To country located outside of your account's home country is considered International. |
Internal Notes |
Data can equal, contain, start with, end with, or be blank |
Item Name |
The name of the order item. ImportantAutomation 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. ImportantAutomation 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. |
# of Line Items |
The number of unique line items in the order - not to be confused with Total Quantity. |
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 Date |
The date the order was placed |
Order # |
The Order Number as displayed in ShipStation |
Order Source |
The original source of the order when importing orders from a Shopping Cart, Inventory Solution, etc. |
Order Subtotal |
The cost of the order prior to calculating customer’s shipping charge and taxes ImportantAutomation Rules using Order Subtotal as criteria will not apply to Shopify orders that import into the On Hold status. |
Order Tags |
Tags that have been added to the order |
Order Total |
The cost of the order, including shipping fees and taxes ImportantAutomation Rules using Order Total as criteria will not apply to Shopify orders that import into the On Hold status. |
Order Weight |
Total order weight ImportantAutomation Rules using Order Weight as criteria will not apply to Shopify orders that import into the On Hold status. |
Package |
The package type selected for the order |
Payment Method |
How the 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 |
Shipping Account |
Which Shipping Account is defined - My Account, Third Party, or Recipient? |
Shipping Paid |
The shipping cost paid by the customer |
Ship By Date |
The already-defined Ship By Date from the marketplace |
Ship from Location |
The defined Ship From Location |
State |
Ship To state |
Store |
The store where the order imported from |
Tax Paid |
The tax amount paid by the customer |
Total Quantity |
Total number of items in order ImportantAutomation Rules using Total Quantity as criteria will not apply to Shopify orders that import into the On Hold status. |
USPS Zone |
USPS Zone based on Ship From and Recipient postal codes |
Warehouse Location |
The Warehouse Location outlined in the product defaults for the order item. ImportantAutomation 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 that you add tags to your product records and use the product tag as 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 Name, Item 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. |
Action |
Description |
---|---|
Add Note to the Buyer… |
Adds text to the Notes to Buyer field in the order. |
Add a Tag... |
Adds the specified tag(s) to the order |
Add an Internal Note… |
Adds notes to the Internal 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. ImportantThis rule can only be applied to an order once. It will not run when automation rules are manually reprocessed. |
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. |
Block Amazon Logistics |
Enables the Block Amazon Logistics shipping option for the shipment. This action will only be present if FBA is connected to the ShipStation account. |
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 Until… |
Places match orders on hold until a specific date. |
Hold the Order for… |
Places a matched order on hold for a specific number of days. |
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 This action typically results in a surcharge. |
Prepay Duties and Taxes |
Currently available only for US to Canada shipments using USPS First Class International service. Automatically assigns one of the following two options to the shipment:
|
Request Confirmation… |
Assigns a specific confirmation type to the order. |
Send an email… |
Sends an email to designated email addresses when the rule runs. If you are in a trial account version, you must contact the ShipStation Support team to have this action enabled for your account. ImportantThis rule can only be applied to an order once. It will not run when automation rules are manually reprocessed. |
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 Notifications (Royal Mail / Parcelforce) |
Enables the SMS and Email notification feature available with Royal Mail and Parcelforce shipments. Not currently available for other carriers. For this action to apply to a shipment, Royal Mail or Parcelforce must already be set as the carrier. This may require additional automation that will set the shipment's carrier before a rule with this action applies. |
Set Package Dimensions… |
Sets the length, width, and height of your order. |
Set Shipping Strategy |
Select a Shipping Strategy (you must have at least one created in your Shipping Settings. Select a Package type for the shipment. |
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 Blank Box |
Enables the Use Blank Box option for an FBA shipment. This action will only be present if FBA is connected to the ShipStation account. |
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. |
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. |