Webhook Changelog

Get all the latest webhook updates by AfterShip Tracking here.

2024-04 (2024-04-11)

Change	Before	After
`as-webhook-version` header’s value	2024-01	2024-04
New tracking model's field	-	`failed_delivery_attempts` `signature_requirement`
Tracking model's field renamed	`checkpoints[x].coordinates`	`checkpoints[x].coordinate`
New event code and reason code are added	-	Event code `picked_up` `signed_by_customer` Reason code `outside_delivery_limits` `not_what_customer_ordered` `package_oversized_overweight`

2024-01 (2024-01-11)

Change	Before	After
`as-webhook-version` header’s value	2023-10	2024-01
New tracking model's field	-	`shipping_method` `location_id` `carbon_emissions` `checkpoints[x].events`
Tracking model's field renamed	`aftership_estimated_delivery_date.confidence_score`	`aftership_estimated_delivery_date.confidence_code`

2023-10 (2023-10-12)

Change	Before	After
New request header	-	There is a new request header `as-webhook-version` e.g. "2023-10" added in the versioned Webhook.
Tracking model's field renamed	`delivery_time`	`transit_time`
Transit time formula updated	Pick up date is considered as 1 transit day When the shipment is delivered: `Transit time (in day) = Delivered date - picked up date + 1` When the shipment is not delivered: `Transit time (in day) = Current date - picked up date + 1`	Pick up date is not considered as 1 day in transit When the shipment is delivered: `Transit time (in day) = Delivered date - picked up date` When the shipment is not delivered: `Transit time (in day) = Current date - picked up date`
The allowed values of `first_estimated_delivery.source` has been changed	`"Carrier EDD"`, `"AI Predictive EDD"`, `"Custom EDD"`, `"Order EDD"`	`"Carrier EDD"`, `"AfterShip EDD"`, `"Custom EDD"`, `"Order EDD"`
The allowed values of `latest_estimated_delivery.source` has been changed	`"Carrier EDD"`, `"AI Predictive EDD"`, `"Custom EDD"`, `"Order EDD"`	`"Carrier EDD"`, `"AfterShip EDD"`, `"Custom EDD"`, `"Order EDD"`

4.4.7(2023-04-20)

Update	Example
A new user agent header will be appended to our webhook requests. The user agent header in webhook requests can provide valuable information to the server and help to improve the performance, security, and reliability of the system.	User-Agent: AfterShipTrackingWebhook/4.0.0 (https://www.aftership.com)

4.4.6(2021-12-07)

Update	Example
New field order_tags added as part of the tracking object. The field indicates the date and time when the order is created.	"order_tags": ["unfulfilled", "unpaid"]

4.4.5(2021-11-03)

Update	Example
New field 'on_time_status' and 'on_time_difference' added as part of the tracking object. The field indicates whether the tracking delivery is on time or not.	"on_time_status": "late", "on_time_difference": 3;

Update	Example
Webhook headers key case updated. No changes are made in the header key, header content, and body section. As HTTP headers naming is conventionally case-insensitive, your code should treat these headers in a case-insensitive manner. If your server is not compliant to process HTTP headers correctly, webhook data processing may fail at your end. Please review the latest webhook header sample for the latest version.

Webhook headers key case updated. No changes are made in the header key, header content, and body section. As HTTP headers naming is conventionally case-insensitive, your code should treat these headers in a case-insensitive manner. If your server is not compliant to process HTTP headers correctly, webhook data processing may fail at your end. Please review the latest webhook header sample for the latest version.

4.4.3(2021-02-04)

Update	Example
New field order_date added as part of the tracking object. The field indicates the date and time when the order is created.	For example, "order_date": "2021-01-01T08:52:54Z"

4.4.2

Update	Example
New subtag is added as part of the tracking and checkpoint object
A new subtag EXCEPTION_013 is added.
New field courier_redirect_link added in tracking object. Delivery instructions (delivery date or address) can be modified by visiting the link if supported by a carrier.

4.4.1

Update	Example
New tag and subtag is added as part of the tracking and checkpoint object
A new tag AvailableForPickup is added
The existing subtag OutForDelivery_002 is replaced with the new subtag AvailableForPickup_001

4.4

Update	Example
`first_attempted_at` (string) - Time of the ﬁrst delivery attempt made by the carrier	"ﬁrst_attempted_at": "2020-02-24T05:43:38+00:00"
`courier_tracking_link` (string, URL) - Courier website direct tracking URL	"courier_tracking_link": "https://www.fedex.com/apps/fedextrack/?tracknumbers=111111111111&cntry_code=US"
`raw_tag` (string): - Status code returned by carriers	"raw_tag": "FPX_L_RPIF"

4.3

Update	Example
Add digital signature `aftership-hmac-sha256` in the request header. This signature is generated by encrypting the webhook body with the webhook secret using SHA256

4.2

Update	Example
`order_promised_delivery_date` (String, YYYY-MM-DD)	"order_promised_delivery_date": "2019-04-23"
`delivery_type` (String, Enum) Available options: `pickup_at_store`, `pickup_at_courier`, `door_to_door`	"delivery_type": "door_to_door"
`pickup_location` (String)	"pickup_location": "Store branch"
`pickup_note` (String)	"pickup_note": "some free text"

Please take note that checkpoint_time and expected_delivery is a string that returns possible value: YYYY-MM-DD, YYYY-MM-DDTHH:MM:SS, or YYYY-MM-DDTHH:MM:SS+TIMEZONE