Manage shipment filters
Shipment filters enable you to precisely fitler delivery events for any updates. This can help you narrow down how or when an issue has occured. Shipment filters are required if you want to setup webhooks. Scroll down to find out how to create & edit Shipment Filters.
To manage shipment filters in Track, go to the Settings > Shipment Filters page. This page enables you to set up new filters & edit or remove existing ones.
Creat a new shipment filter
Go to Settings > Shipment Filters to display the Create & Manage Shipment Filters page.
Click Create New Shipment Filter.
Type a Shipment Filter name & click Next.
Tip
We recommend the filter name should be related to the business process you want to drive with the filter. For example, "Contact Required" would be a better choice of filter name than "SMS".
Click to select the carriers you want in the shipment filter.
(Optional) You can click to Select all carriers.
When done, click Next at the bottom.
Note
If you do not select any carriers, the filter will trigger for shipments with all carriers.
Click to select the Shipment states and/or Calculated events you want in your Shipment filter. At least one selection is required.
Click for more information on Shipment states & Calculated Events
When done, click Next.
The example below uses the filter to find the Delayed Shipment state & then selects the Late Calculated event.
View your selections & click Next to confirm.
(Optional) From here, you can click to remove any states or events you don't want anymore.
Click the shipment types you want to include in your filter. When done, click Next.
(Optional) You can click to Select all shipment types if you want.
(Optional) Add any shipment tags you want by typing a name & clicking the plus button. If you add tags here, only the shipments that include your defined tag will trigger a webhook.
When you have added any tags you need, click Create Filter to finish. Your new filter appears as a tile on the Shipment Filters page.
Note
You can add tags to shipments via the Register Shipments & Update Shipments endpoints. For more information, checkout our guides on Registering Shipmets (API) and Updating Shipments (API).
(Optional) You can click the tick box if you want to trigger the shipment filter once per grouping. If you do not want this, just click Create Filter. For more information, see our article on Shipment Groupings.
Once you have clicked the tick-box, use the drop-down to choose the Grouping Metakey & type how long you want to restrict for (in minutes). When done, click Create Filter.
Well done! You have created a Shipment Filter. If you are following this guide as part of setting up webhooks, click here for our guide. Otherwise, scroll down if you want to find out how to edit Shipment filters.
Edit existing shipment filters
To edit an existing shipment filter, click the Edit button on that filter's tile.
The process of editing a filter is exactly the same as when creating one.
To delete an existing shipment filter, click the Delete button on that filter's tile & click Confirm on the pop-up confirmation dialog. You cannot delete a shipment filter if it is currently being used by one or more webhooks.
User access
Admin & Marketing users can view, edit & delete shipment filters.
Dashboard users do not have access to this feature.