coreFORCE - Orders: Tracking and Delivery Notifications from EasyPost in coreFORCE
coreFORCE Advanced and Enterprise Only
From the backend site for coreFORCE, go to the following page and follow the instructions on the page:
<your domain>/easypost-webhook
If this URL does not work, contact Coreware support to create the page for you.
The instructions on that page include the link the create the webhook on the EasyPost site. When you create the webhook, be sure to copy the full URL shown on the page including the key=..... parameter. Your EasyPost webhook should look something like this:
https://<your domain>/easypost-webhook?key=LcaU8M8gI0di39bYibCW67ea
do not include [www] at the start of your domain name. If EasyPost encounters a redirect (from www to the bare domain), the content that it is sending will be lost.
Once the webhook is created on the EasyPost site, coreFORCE will begin receing status updates for tracked packages. These will be added to the notes field of the shipment that was created with EasyPost (viewable in the Orders Dashboard). You can also create emails to be sent to the client at each stage of shipment. The following emails are supported:
RETAIL_STORE_TRACKING_EMAIL_PRE_TRANSIT
RETAIL_STORE_TRACKING_EMAIL_IN_TRANSIT
RETAIL_STORE_TRACKING_EMAIL_OUT_FOR_DELIVERY
RETAIL_STORE_TRACKING_EMAIL_DELIVERED
RETAIL_STORE_TRACKING_EMAIL_AVAILABLE_FOR_PICKUP
RETAIL_STORE_TRACKING_EMAIL_RETURN_TO_SENDER
RETAIL_STORE_TRACKING_EMAIL_FAILURE
RETAIL_STORE_TRACKING_EMAIL_CANCELLED
RETAIL_STORE_TRACKING_EMAIL_ERROR
RETAIL_STORE_TRACKING_EMAIL_UNKNOWN
It is NOT recommended to create all of these. Start with the most important ones, probably:
RETAIL_STORE_TRACKING_EMAIL_OUT_FOR_DELIVERY
RETAIL_STORE_TRACKING_EMAIL_DELIVERED
Once you are confident about how those are working, you can add more.
A few notes on the others:
RETAIL_STORE_TRACKING_EMAIL_UNKNOWN - This is the initial status before anything updates in the system. We do not recommend creating this email because it will probably be sent within a few minutes of the coreFORCE RETAIL_STORE_TRACKING_EMAIL.
RETAIL_STORE_TRACKING_EMAIL_PRE_TRANSIT - This status is triggered as soon as the carrier picks up the package. We do not recommend creating an email for this because it would be triggered the same day as the shipment is created.
RETAIL_STORE_TRACKING_EMAIL_IN_TRANSIT - This status will happen multiple times as the shipment moves along. However, our code will only send the email the first time it sees this status, so this could be a good one to create; it would indicate to the customer that the shipment is moving.
RETAIL_STORE_TRACKING_EMAIL_AVAILABLE_FOR_PICKUP - Depending on the customer, this probably will not happen very often, and if it does, the customer will probably already have received a pickup notice from the carrier. However, it could be useful to create this.
The remaining status updates are probably pretty unusual and may not even be relevant to the customer. We do not suggest creating emails for them unless you encounter a situation in which you need them:
RETAIL_STORE_TRACKING_EMAIL_RETURN_TO_SENDER
RETAIL_STORE_TRACKING_EMAIL_FAILURE
RETAIL_STORE_TRACKING_EMAIL_CANCELLED
RETAIL_STORE_TRACKING_EMAIL_ERROR
There is no default content for these emails. You can begin by copying the content from RETAIL_STORE_TRACKING_EMAIL and editing the subject line and the content as appropriate. A sample from the Coreware demo store is shown in the screenshot below.
There are a few extra placeholders that are added by EasyPost, but the only one that's likely to be useful is %public_url% - that's an EasyPost-hosted page with your logo at the top (assuming you uploaded your logo to the EasyPost dashboard), that shows the full tracking history for the shipment.
From the backend site for coreFORCE, go to the following page and follow the instructions on the page:
<your domain>/easypost-webhook
If this URL does not work, contact Coreware support to create the page for you.
The instructions on that page include the link the create the webhook on the EasyPost site. When you create the webhook, be sure to copy the full URL shown on the page including the key=..... parameter. Your EasyPost webhook should look something like this:
https://<your domain>/easypost-webhook?key=LcaU8M8gI0di39bYibCW67ea
do not include [www] at the start of your domain name. If EasyPost encounters a redirect (from www to the bare domain), the content that it is sending will be lost.
Once the webhook is created on the EasyPost site, coreFORCE will begin receing status updates for tracked packages. These will be added to the notes field of the shipment that was created with EasyPost (viewable in the Orders Dashboard). You can also create emails to be sent to the client at each stage of shipment. The following emails are supported:
RETAIL_STORE_TRACKING_EMAIL_PRE_TRANSIT
RETAIL_STORE_TRACKING_EMAIL_IN_TRANSIT
RETAIL_STORE_TRACKING_EMAIL_OUT_FOR_DELIVERY
RETAIL_STORE_TRACKING_EMAIL_DELIVERED
RETAIL_STORE_TRACKING_EMAIL_AVAILABLE_FOR_PICKUP
RETAIL_STORE_TRACKING_EMAIL_RETURN_TO_SENDER
RETAIL_STORE_TRACKING_EMAIL_FAILURE
RETAIL_STORE_TRACKING_EMAIL_CANCELLED
RETAIL_STORE_TRACKING_EMAIL_ERROR
RETAIL_STORE_TRACKING_EMAIL_UNKNOWN
It is NOT recommended to create all of these. Start with the most important ones, probably:
RETAIL_STORE_TRACKING_EMAIL_OUT_FOR_DELIVERY
RETAIL_STORE_TRACKING_EMAIL_DELIVERED
Once you are confident about how those are working, you can add more.
A few notes on the others:
RETAIL_STORE_TRACKING_EMAIL_UNKNOWN - This is the initial status before anything updates in the system. We do not recommend creating this email because it will probably be sent within a few minutes of the coreFORCE RETAIL_STORE_TRACKING_EMAIL.
RETAIL_STORE_TRACKING_EMAIL_PRE_TRANSIT - This status is triggered as soon as the carrier picks up the package. We do not recommend creating an email for this because it would be triggered the same day as the shipment is created.
RETAIL_STORE_TRACKING_EMAIL_IN_TRANSIT - This status will happen multiple times as the shipment moves along. However, our code will only send the email the first time it sees this status, so this could be a good one to create; it would indicate to the customer that the shipment is moving.
RETAIL_STORE_TRACKING_EMAIL_AVAILABLE_FOR_PICKUP - Depending on the customer, this probably will not happen very often, and if it does, the customer will probably already have received a pickup notice from the carrier. However, it could be useful to create this.
The remaining status updates are probably pretty unusual and may not even be relevant to the customer. We do not suggest creating emails for them unless you encounter a situation in which you need them:
RETAIL_STORE_TRACKING_EMAIL_RETURN_TO_SENDER
RETAIL_STORE_TRACKING_EMAIL_FAILURE
RETAIL_STORE_TRACKING_EMAIL_CANCELLED
RETAIL_STORE_TRACKING_EMAIL_ERROR
There is no default content for these emails. You can begin by copying the content from RETAIL_STORE_TRACKING_EMAIL and editing the subject line and the content as appropriate. A sample from the Coreware demo store is shown in the screenshot below.
There are a few extra placeholders that are added by EasyPost, but the only one that's likely to be useful is %public_url% - that's an EasyPost-hosted page with your logo at the top (assuming you uploaded your logo to the EasyPost dashboard), that shows the full tracking history for the shipment.
Updated on: 07/01/2024
Thank you!