Learn About Shipment Custom Fields
Plans: Premium, Enterprise Advanced Platforms: Tracking API, Non-API, All platforms
AfterShip Tracking allows you to use custom field keys to filter the shipments and analytics data to help better manage shipments in your business dimension and add extra information. Custom fields can be added via
AfterShip Tracking API when importing shipments via API
Shipment detail page in the Custom fields category
a. Go to Tracking dashboards > Shipments in your AfterShip Tracking admin
b. Click on a shipment to which to would like to add custom fields
c. Move to the Custom fields section on the shipment details side panel and click Add to open the popup
d. Input the field name and value and click Save
E.g., Field name: store_name, Value: Sephora
The newly created custom fields will be automatically available to select if you want to filter shipments by specific custom fields
The custom field names appear as a column heading on the dashboard when selected
Go to Shipments in the AfterShip Tracking admin
Click Add filters and move down to Advanced category. Click on Custom fields >
A side panel with custom fields will open. Click +Add custom field and select the field based on which you want to filter shipments
You can also select between the following options to micro-filer data (optional)
a. Is any of: When you want all the shipments that contain the corresponding value(s) to be filtered out
b. Is none of: When you want the shipments that do not contain the corresponding value(s) to be filtered out
Select the value from the dropdown below
The shipments will be automatically populated based on the custom fields and values you applied and the basic filters already selected.
To add these custom fields as column headers on the dashboard, click the column icon and select Add custom fields
Select the checkbox of custom fields you want on the shipment dashboard as column headers and hit Done
After the basic filters, the custom fields will be visible as column headers with their respective values.
Once you have set up and configured the custom fields either through the shipment detail page or Tracking API, you will get the direct option to select the custom fields to populate analytics data based on them for the Shipments, Transit times, On-time shipments, Exceptions, and Notifications analytics.
Go to Analytics in the AfterShip Tracking admin. Select the page for which you want to review data
Click on {/} Custom fields, then click +Add custom field and select the field(s) based on which you want to filter data
You can also select between the following options to micro-filer data (optional)
Select the value from the dropdown list
The data will be automatically populated based on the custom fields and values you applied and the basic filters already selected.
Overview
AfterShip Tracking allows you to use custom field keys to filter the shipments and analytics data to help better manage shipments in your business dimension and add extra information. Custom fields can be added via
AfterShip Tracking API when importing shipments via API
Shipment detail page in the Custom fields category
a. Go to Tracking dashboards > Shipments in your AfterShip Tracking admin
b. Click on a shipment to which to would like to add custom fields
c. Move to the Custom fields section on the shipment details side panel and click Add to open the popup
d. Input the field name and value and click Save
E.g., Field name: store_name, Value: Sephora
The newly created custom fields will be automatically available to select if you want to filter shipments by specific custom fields
The custom field names appear as a column heading on the dashboard when selected
Apply custom field filter to shipments
A. Shipment dashboard
Go to Shipments in the AfterShip Tracking admin
Click Add filters and move down to Advanced category. Click on Custom fields >
A side panel with custom fields will open. Click +Add custom field and select the field based on which you want to filter shipments
You can also select between the following options to micro-filer data (optional)
a. Is any of: When you want all the shipments that contain the corresponding value(s) to be filtered out
b. Is none of: When you want the shipments that do not contain the corresponding value(s) to be filtered out
Select the value from the dropdown below
The shipments will be automatically populated based on the custom fields and values you applied and the basic filters already selected.
To add these custom fields as column headers on the dashboard, click the column icon and select Add custom fields
Select the checkbox of custom fields you want on the shipment dashboard as column headers and hit Done
After the basic filters, the custom fields will be visible as column headers with their respective values.
B. Analytics page
Once you have set up and configured the custom fields either through the shipment detail page or Tracking API, you will get the direct option to select the custom fields to populate analytics data based on them for the Shipments, Transit times, On-time shipments, Exceptions, and Notifications analytics.
Go to Analytics in the AfterShip Tracking admin. Select the page for which you want to review data
Click on {/} Custom fields, then click +Add custom field and select the field(s) based on which you want to filter data
You can also select between the following options to micro-filer data (optional)
Select the value from the dropdown list
The data will be automatically populated based on the custom fields and values you applied and the basic filters already selected.
Updated on: 09/04/2024
Thank you!