Webhooks

Shipment update (format 5.3)

Everything in format 5.2, with two changes:

expected_delivery is restructured: instead of a single from/to window, it exposes the EDD from each source separately — merchant, carrier, predict_engine, and display (the value shown in the product, following your account’s EDD display priority; ask your account team to review it).
pa_results lists Performance Aspiration evaluations for the Shipment — empty unless the Performance Aspiration module is enabled.

The emitted version value for this format is 5.3.0. Contact your account team to enable format 5.3. Delivery and authentication are identical to format 5.0.

WEBHOOK

shipment-update-v5-3

{
  "data": {
    "shipment_uuid": "00000000-0000-4000-8000-000000000001",
    "shipment_id": "SHP-EXAMPLE-PA-001",
    "shipment_reference": null,
    "additional_reference": null,
    "tracking_number": "PPEXAMPLE10005301",
    "carrier_reference": "ppmc",
    "carrier": {
      "id": "mocarr",
      "name": "Perform.AI Mock Carrier",
      "country_iso": [
        "VN"
      ],
      "language": [
        "vi"
      ],
      "supported_languages": [
        "en"
      ],
      "contact": "+4509845390",
      "site_link": "https://www.perform.ai/"
    },
    "created_date": "2026-03-19T07:03:17+00:00",
    "updated_date": "2026-07-27T04:38:54+00:00",
    "source": "api",
    "status": "active",
    "current_phase": {
      "name": "Out for delivery",
      "key": "G"
    },
    "tags": [
      "eu-warehouse",
      "sla_order_placed_to_pickup_compliant",
      "priority"
    ],
    "notification_email": [],
    "notification_phone": [],
    "tracking_page_reference": null,
    "order": {
      "order_uuid": null,
      "order_id": null,
      "order_reference": "",
      "source_type": "",
      "source_name": "",
      "created_date": null,
      "updated_date": null
    },
    "recipient_address": null,
    "sender_address": null,
    "to_address": null,
    "from_address": {
      "full": "Germany",
      "address_name": null,
      "location_type": null,
      "entity_reference": null,
      "first_name": null,
      "last_name": null,
      "line1": null,
      "line2": null,
      "line3": null,
      "city": null,
      "postal_code": null,
      "state_or_province": null,
      "region": null,
      "country": "Germany",
      "country_code": "DE",
      "email": null,
      "phone": null,
      "company": null,
      "tax_id": null
    },
    "return_address": null,
    "shipment_value": null,
    "total_shipping_cost": null,
    "shipping_costs": [],
    "cod_value": null,
    "dimensions": {
      "length": null,
      "width": null,
      "height": null,
      "unit": "cm"
    },
    "weight": null,
    "linked_shipments": [],
    "expected_delivery": {
      "merchant": null,
      "carrier": null,
      "predict_engine": null,
      "display": null
    },
    "payment_type": null,
    "item_count": null,
    "packaging_type": null,
    "note": null,
    "shipping_service": null,
    "description_of_goods": null,
    "handling_instructions": null,
    "sales_channel": null,
    "documents": [],
    "additional_info": {
      "message": "Parcel not found"
    },
    "latest_event": {
      "event": "Arrived at Parcel Shop",
      "event_key": "G32",
      "phase": "Out for delivery",
      "phase_key": "G",
      "time": "2026-07-27T11:38:53+00:00",
      "timezone": "Etc/UTC",
      "carrier_name": "Perform.AI Mock Carrier",
      "location": {
        "place": "Vietnam",
        "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
        "formatted_address": "Vietnam",
        "location_type": "",
        "line1": "",
        "line2": "",
        "line3": null,
        "postal_code": "",
        "city": "",
        "state_or_province": "",
        "region": "",
        "country": "Vietnam",
        "country_code": "VN",
        "longitude": 108.277199,
        "latitude": 14.058324,
        "timezone": "Asia/Ho_Chi_Minh"
      },
      "additional_info": {}
    },
    "new_events": [
      {
        "event": "Arrived at Parcel Shop",
        "event_key": "G32",
        "phase": "Out for delivery",
        "phase_key": "G",
        "time": "2026-07-27T11:38:53+00:00",
        "timezone": "Etc/UTC",
        "carrier_name": "Perform.AI Mock Carrier",
        "location": {
          "place": "Vietnam",
          "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
          "formatted_address": "Vietnam",
          "location_type": "",
          "line1": "",
          "line2": "",
          "line3": null,
          "postal_code": "",
          "city": "",
          "state_or_province": "",
          "region": "",
          "country": "Vietnam",
          "country_code": "VN",
          "longitude": 108.277199,
          "latitude": 14.058324,
          "timezone": "Asia/Ho_Chi_Minh"
        },
        "additional_info": {}
      },
      {
        "event": "Arrived at Parcel Locker",
        "event_key": "G31",
        "phase": "Out for delivery",
        "phase_key": "G",
        "time": "2026-07-27T11:36:43+00:00",
        "timezone": "Etc/UTC",
        "carrier_name": "Perform.AI Mock Carrier",
        "location": {
          "place": "Vietnam",
          "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
          "formatted_address": "Vietnam",
          "location_type": "",
          "line1": "",
          "line2": "",
          "line3": null,
          "postal_code": "",
          "city": "",
          "state_or_province": "",
          "region": "",
          "country": "Vietnam",
          "country_code": "VN",
          "longitude": 108.277199,
          "latitude": 14.058324,
          "timezone": "Asia/Ho_Chi_Minh"
        },
        "additional_info": {}
      }
    ],
    "all_events": [
      {
        "event": "Arrived at Parcel Shop",
        "event_key": "G32",
        "phase": "Out for delivery",
        "phase_key": "G",
        "time": "2026-07-27T11:38:53+00:00",
        "timezone": "Etc/UTC",
        "carrier_name": "Perform.AI Mock Carrier",
        "location": {
          "place": "Vietnam",
          "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
          "formatted_address": "Vietnam",
          "location_type": "",
          "line1": "",
          "line2": "",
          "line3": null,
          "postal_code": "",
          "city": "",
          "state_or_province": "",
          "region": "",
          "country": "Vietnam",
          "country_code": "VN",
          "longitude": 108.277199,
          "latitude": 14.058324,
          "timezone": "Asia/Ho_Chi_Minh"
        },
        "additional_info": {}
      },
      {
        "event": "Arrived at Parcel Locker",
        "event_key": "G31",
        "phase": "Out for delivery",
        "phase_key": "G",
        "time": "2026-07-27T11:36:43+00:00",
        "timezone": "Etc/UTC",
        "carrier_name": "Perform.AI Mock Carrier",
        "location": {
          "place": "Vietnam",
          "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
          "formatted_address": "Vietnam",
          "location_type": "",
          "line1": "",
          "line2": "",
          "line3": null,
          "postal_code": "",
          "city": "",
          "state_or_province": "",
          "region": "",
          "country": "Vietnam",
          "country_code": "VN",
          "longitude": 108.277199,
          "latitude": 14.058324,
          "timezone": "Asia/Ho_Chi_Minh"
        },
        "additional_info": {}
      }
    ],
    "returns": null,
    "collection_point": null,
    "shipment_type": null,
    "rating": null,
    "line_items": [],
    "parcel_recipient_information": null,
    "tracking_page_url": "https://www.perform.ai/tracking/?pp_tracking_id=PPEXAMPLE10005301",
    "pod_url": null,
    "pa_results": [
      {
        "category_name": "Order placed to Pickup",
        "rule_name": "DE Warehouse",
        "outcome": "compliant",
        "expected_result": 3,
        "result": 0,
        "transit_time_unit": "day",
        "expected_result_date": null,
        "result_date": "2026-03-09T17:01:00+00:00",
        "from_milestone": {
          "type": "order_placed",
          "time": "2026-03-09T17:01:00+00:00"
        },
        "to_milestone": {
          "type": "pickup",
          "time": "2026-03-09T17:01:00+00:00"
        },
        "created_date": "2026-03-19T07:03:20.227000+00:00"
      },
      {
        "category_name": "Kate test PA",
        "rule_name": "Kate Test Rule 02",
        "outcome": "compliant",
        "expected_result": 4,
        "result": 0,
        "transit_time_unit": "day",
        "expected_result_date": null,
        "result_date": "2026-03-10T06:00:00+00:00",
        "from_milestone": {
          "type": "pickup",
          "time": "2026-03-09T17:01:00+00:00"
        },
        "to_milestone": {
          "type": "first_attempt",
          "time": "2026-03-10T06:00:00+00:00"
        },
        "created_date": "2026-03-19T07:03:20.286000+00:00"
      }
    ]
  },
  "trigger": [
    "all_events"
  ],
  "version": "5.3.0",
  "notification_type": "shipment_notification"
}

Authorizations

Authorization

string

header

required

Used by every functional endpoint. Generate the token with POST /auth/oauth/token/ and send it as Authorization: Bearer {token}.

Body

application/json

data

object

The data object of a format-5.0 shipment update webhook.

Show child attributes

trigger

string[]

version

string

5.3.0 for this format.

notification_type

string

Always shipment_notification.

Response

200

Return HTTP 200 to acknowledge receipt.

{
  "data": {
    "shipment_uuid": "00000000-0000-4000-8000-000000000001",
    "shipment_id": "SHP-EXAMPLE-PA-001",
    "shipment_reference": null,
    "additional_reference": null,
    "tracking_number": "PPEXAMPLE10005301",
    "carrier_reference": "ppmc",
    "carrier": {
      "id": "mocarr",
      "name": "Perform.AI Mock Carrier",
      "country_iso": [
        "VN"
      ],
      "language": [
        "vi"
      ],
      "supported_languages": [
        "en"
      ],
      "contact": "+4509845390",
      "site_link": "https://www.perform.ai/"
    },
    "created_date": "2026-03-19T07:03:17+00:00",
    "updated_date": "2026-07-27T04:38:54+00:00",
    "source": "api",
    "status": "active",
    "current_phase": {
      "name": "Out for delivery",
      "key": "G"
    },
    "tags": [
      "eu-warehouse",
      "sla_order_placed_to_pickup_compliant",
      "priority"
    ],
    "notification_email": [],
    "notification_phone": [],
    "tracking_page_reference": null,
    "order": {
      "order_uuid": null,
      "order_id": null,
      "order_reference": "",
      "source_type": "",
      "source_name": "",
      "created_date": null,
      "updated_date": null
    },
    "recipient_address": null,
    "sender_address": null,
    "to_address": null,
    "from_address": {
      "full": "Germany",
      "address_name": null,
      "location_type": null,
      "entity_reference": null,
      "first_name": null,
      "last_name": null,
      "line1": null,
      "line2": null,
      "line3": null,
      "city": null,
      "postal_code": null,
      "state_or_province": null,
      "region": null,
      "country": "Germany",
      "country_code": "DE",
      "email": null,
      "phone": null,
      "company": null,
      "tax_id": null
    },
    "return_address": null,
    "shipment_value": null,
    "total_shipping_cost": null,
    "shipping_costs": [],
    "cod_value": null,
    "dimensions": {
      "length": null,
      "width": null,
      "height": null,
      "unit": "cm"
    },
    "weight": null,
    "linked_shipments": [],
    "expected_delivery": {
      "merchant": null,
      "carrier": null,
      "predict_engine": null,
      "display": null
    },
    "payment_type": null,
    "item_count": null,
    "packaging_type": null,
    "note": null,
    "shipping_service": null,
    "description_of_goods": null,
    "handling_instructions": null,
    "sales_channel": null,
    "documents": [],
    "additional_info": {
      "message": "Parcel not found"
    },
    "latest_event": {
      "event": "Arrived at Parcel Shop",
      "event_key": "G32",
      "phase": "Out for delivery",
      "phase_key": "G",
      "time": "2026-07-27T11:38:53+00:00",
      "timezone": "Etc/UTC",
      "carrier_name": "Perform.AI Mock Carrier",
      "location": {
        "place": "Vietnam",
        "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
        "formatted_address": "Vietnam",
        "location_type": "",
        "line1": "",
        "line2": "",
        "line3": null,
        "postal_code": "",
        "city": "",
        "state_or_province": "",
        "region": "",
        "country": "Vietnam",
        "country_code": "VN",
        "longitude": 108.277199,
        "latitude": 14.058324,
        "timezone": "Asia/Ho_Chi_Minh"
      },
      "additional_info": {}
    },
    "new_events": [
      {
        "event": "Arrived at Parcel Shop",
        "event_key": "G32",
        "phase": "Out for delivery",
        "phase_key": "G",
        "time": "2026-07-27T11:38:53+00:00",
        "timezone": "Etc/UTC",
        "carrier_name": "Perform.AI Mock Carrier",
        "location": {
          "place": "Vietnam",
          "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
          "formatted_address": "Vietnam",
          "location_type": "",
          "line1": "",
          "line2": "",
          "line3": null,
          "postal_code": "",
          "city": "",
          "state_or_province": "",
          "region": "",
          "country": "Vietnam",
          "country_code": "VN",
          "longitude": 108.277199,
          "latitude": 14.058324,
          "timezone": "Asia/Ho_Chi_Minh"
        },
        "additional_info": {}
      },
      {
        "event": "Arrived at Parcel Locker",
        "event_key": "G31",
        "phase": "Out for delivery",
        "phase_key": "G",
        "time": "2026-07-27T11:36:43+00:00",
        "timezone": "Etc/UTC",
        "carrier_name": "Perform.AI Mock Carrier",
        "location": {
          "place": "Vietnam",
          "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
          "formatted_address": "Vietnam",
          "location_type": "",
          "line1": "",
          "line2": "",
          "line3": null,
          "postal_code": "",
          "city": "",
          "state_or_province": "",
          "region": "",
          "country": "Vietnam",
          "country_code": "VN",
          "longitude": 108.277199,
          "latitude": 14.058324,
          "timezone": "Asia/Ho_Chi_Minh"
        },
        "additional_info": {}
      }
    ],
    "all_events": [
      {
        "event": "Arrived at Parcel Shop",
        "event_key": "G32",
        "phase": "Out for delivery",
        "phase_key": "G",
        "time": "2026-07-27T11:38:53+00:00",
        "timezone": "Etc/UTC",
        "carrier_name": "Perform.AI Mock Carrier",
        "location": {
          "place": "Vietnam",
          "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
          "formatted_address": "Vietnam",
          "location_type": "",
          "line1": "",
          "line2": "",
          "line3": null,
          "postal_code": "",
          "city": "",
          "state_or_province": "",
          "region": "",
          "country": "Vietnam",
          "country_code": "VN",
          "longitude": 108.277199,
          "latitude": 14.058324,
          "timezone": "Asia/Ho_Chi_Minh"
        },
        "additional_info": {}
      },
      {
        "event": "Arrived at Parcel Locker",
        "event_key": "G31",
        "phase": "Out for delivery",
        "phase_key": "G",
        "time": "2026-07-27T11:36:43+00:00",
        "timezone": "Etc/UTC",
        "carrier_name": "Perform.AI Mock Carrier",
        "location": {
          "place": "Vietnam",
          "full": "Vietnam, VN, 108.277199, 14.058324, Asia/Ho_Chi_Minh",
          "formatted_address": "Vietnam",
          "location_type": "",
          "line1": "",
          "line2": "",
          "line3": null,
          "postal_code": "",
          "city": "",
          "state_or_province": "",
          "region": "",
          "country": "Vietnam",
          "country_code": "VN",
          "longitude": 108.277199,
          "latitude": 14.058324,
          "timezone": "Asia/Ho_Chi_Minh"
        },
        "additional_info": {}
      }
    ],
    "returns": null,
    "collection_point": null,
    "shipment_type": null,
    "rating": null,
    "line_items": [],
    "parcel_recipient_information": null,
    "tracking_page_url": "https://www.perform.ai/tracking/?pp_tracking_id=PPEXAMPLE10005301",
    "pod_url": null,
    "pa_results": [
      {
        "category_name": "Order placed to Pickup",
        "rule_name": "DE Warehouse",
        "outcome": "compliant",
        "expected_result": 3,
        "result": 0,
        "transit_time_unit": "day",
        "expected_result_date": null,
        "result_date": "2026-03-09T17:01:00+00:00",
        "from_milestone": {
          "type": "order_placed",
          "time": "2026-03-09T17:01:00+00:00"
        },
        "to_milestone": {
          "type": "pickup",
          "time": "2026-03-09T17:01:00+00:00"
        },
        "created_date": "2026-03-19T07:03:20.227000+00:00"
      },
      {
        "category_name": "Kate test PA",
        "rule_name": "Kate Test Rule 02",
        "outcome": "compliant",
        "expected_result": 4,
        "result": 0,
        "transit_time_unit": "day",
        "expected_result_date": null,
        "result_date": "2026-03-10T06:00:00+00:00",
        "from_milestone": {
          "type": "pickup",
          "time": "2026-03-09T17:01:00+00:00"
        },
        "to_milestone": {
          "type": "first_attempt",
          "time": "2026-03-10T06:00:00+00:00"
        },
        "created_date": "2026-03-19T07:03:20.286000+00:00"
      }
    ]
  },
  "trigger": [
    "all_events"
  ],
  "version": "5.3.0",
  "notification_type": "shipment_notification"
}

Overview

Authentication

Shipments

Booking

Documents

PUDO locations

Carrier configurations

Events

Returns

Webhooks

Checkout

Shipment update (format 5.3)

Authorizations

Body

Response