Get all the latest webhook updates by AfterShip here.

4.4.5 (Launching on 3th Nov 2021)

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.
For example, "on_time_status": "late", "on_time_difference": 3;

4.4.4 (Launching on 10th May 2021)

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 (Launched on 4th February 2021)

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

  1. New subtag is added as part of the tracking and checkpoint object
  2. A new subtag EXCEPTION_013 is added.
  3. 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

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

4.4

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

4.3

  1. 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

Added 4 new fields under msg object:

  1. order_promised_delivery_date (String, YYYY-MM-DD)
    For example, "order_promised_delivery_date": "2019-04-23"
  2. delivery_type (String, Enum)
    For example, "delivery_type": "door_to_door"
    Available options: pickup_at_store, pickup_at_courier, door_to_door
  3. pickup_location (String)
    For example, "pickup_location": "Store branch"
  4. pickup_note (String)
    For example, "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