Skip to main content
Notifications
← Back
Throughout This Page
You can jump to the specified sections by clicking on these titles.

Overview

Welcome to our Shipping API documentation, where we present a powerful feature enabling you to send notifications triggered by specific events. With this functionality, you can effortlessly inform your customers about shipment milestones such as booking, dispatch, and delivery. It enhances the post-purchase experience and provides a valuable avenue for gathering user feedback on your business.

In this guide, we will walk you through creating notifications. We'll introduce you to the options on the Notifications page and demonstrate how to manage and edit your notifications effectively.

Accessing the Notifications Page

Click the "Notifications" button from the left-hand menu to access it.

Creating a Notification

Click the "Create Notification" button in the page's top right corner.

If you encounter an error message indicating the need to configure an email template or email account before proceeding, you must set these up before creating a notification. Refer to our "Email Templates" and "Email Settings" pages for detailed instructions on how to do this.

Upon clicking the "Create Notification" button, a window will appear where you can configure the filters and details for your notifications:

  • Notification Name: Choose a name for your notification; it can be anything you prefer.
  • API Account: Select the API account for which you wish to enable the notification feature.
  • Linked Couriers: After selecting the API account, specify the courier or couriers you want to notify customers about triggered events.
  • Parameter: By default, "Tracking Status" is selected as the parameter, but you can add another parameter by clicking the "Add Parameter" button. The additional parameter available is "Delay Time."
  • Tracking Status: Choose the tracking status or statuses you want to trigger customer notifications. For more information about tracking statuses, refer to our "Tracking API" document.
  • Delay Time: Specify the time delay, in days, after the triggered status for the email to be sent. For example, if you select "Delivered" as the tracking status and enter "7D" in the "Delay Time" field, the email will be sent seven days after we receive notification of delivery. This option allows you to send emails requesting reviews, for instance.

Once you have filled in these fields, click "Continue" to proceed to the next page.

On the next page, you'll configure additional details for your notification:

  • Subject Line: This is the subject of the emails that will be sent. Customize it to reflect the purpose of the email, such as "Please leave a review."
  • Mail Account: Choose one of the mail accounts you previously created on the "Email Settings" tab.
  • Sender Name: Enter the email sender's name as you want it to appear in the email.
  • Sender Email: Provide the sender's email address, which will be shown as the "from" address. Note that this email address should be defined in your mail provider settings.
  • Email Template: Click the pencil icon to access the Email Template tab and select one of the templates you created earlier.

After filling in all the necessary fields and selecting the desired template, click "Create Notification."

Congratulations! You have successfully created the notification, which will now appear in your list of notifications.

Notification Options

Let's explore the various options available for your created notifications:

  • Status: You can set the notification as "Active" or "Inactive" by clicking the button adjacent to it.
  • Play Button: To ensure your notification has been configured correctly, click on the test button associated with that notification. It allows you to test the notification, and the system will provide feedback on whether the test was successful or unsuccessful.
  • Edit: If you need to change a notification, click the pencil icon in the edit column to access the editing options.
  • Delete: If you wish to remove a notification, you can do so by clicking on the trash bin icon.

Filters

Filters are crucial in refining your search results based on your specific requirements. Here's an overview of the available filter options:

  • Name: If you're looking for a notification with a particular name or a part of it, you can input the name in this field to narrow down your search results.
  • Status Trigger: This filter allows you to view notifications with specific trigger statuses, such as "Booked," "Collected," "Delivered," and more. Select the desired status(es) to filter the results accordingly.
  • Mail Account: If you've added multiple mail accounts and need to focus on specific ones, use this filter to isolate the desired mail account(s).
  • API Account: To view notifications associated with particular API accounts, make your selection from this filter.
  • Linked Couriers: With this filter, you can specify the courier(s) for which you want to view related notifications.
  • Status: If you want to differentiate between "Active" and "Inactive" notifications, you can use this filter to display notifications based on their status.

Additionally, you can choose which columns are visible to you by accessing the "Column Selector." Similarly, you can customize which filters are displayed in the "Filter Selector" section, represented by the highlighted circle icon between the filter columns and the "Create Notification" button.

Back to top