This page lists the available topics to specify when subscribing to Webhooks and provides examples for the event data which is sent via an HTTP POST request to the webhook url. “unique_id” is deprecated and should not be used.

Event Payloads


order:created

{
    "topic" : "order:created",
    "message" : {
        "unique_id" : "100000015",
        "order_ref" : "9099",
        "source" : null,
        "stock_adjustments" : {
            "sku123" : {
                "sku" : "sku123",
                "external_id" : null,
                "product_id" : 7,
                "qty_adjust" : -5,
                "qty_available": 95,
                "qty_advertised": 95
            }
        },
        "webhook_increment_id" : 2,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

order:canceled

{
    "topic" : "order:canceled",
    "message" : {
        "unique_id" : "100000016",
        "order_ref" : "9099",
        "source" : null,
        "stock_adjustments" : {
            "sku123" : {
                "sku" : "sku123",
                "external_id" : null,
                "product_id" : 7,
                "qty_adjust" : 5,
                "qty_available": 95,
                "qty_advertised": 95
            }
        },
        "shipments": [ {"unique_id" : "100000026"} ],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

order:holded

{
    "topic" : "order:holded",
    "message" : {
        "unique_id" : "100000017",
        "order_ref" : "9099",
        "source" : null,
        "webhook_increment_id" : 3,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

order:completed

{
    "topic" : "order:completed",
    "message" : {
        "unique_id" : "100000020",
        "order_ref" : "9099",
        "source" : null,
        "webhook_increment_id" : 5,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

order:shipped

{
    "topic" : "order:shipped",
    "message" : {
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "shipments" : [
            {
              "unique_id" : "100000033",
              "warehouse_id": 1,
              "carrier": "fedex",
              "status" : "shipped",
              "service": "GROUND_HOME_DELIVERY",
              "trackers" : [{
                "tracker_id" : 4,
                "status" : "in_transit",
                "carrier" : "fedex",
                "tracking_number" : "794657040105",
                "carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
                "est_delivery_at" : "2021-10-05T00:00:00-04:00",
                "is_est_delivery_at_date" : true,
                "original_est_delivery_at" : "2021-10-05T00:00:00-04:00",
                "is_original_est_delivery_at_date" : true,
                "delivered_at" : null,
                "signed_by" : null
              }]
            }
        ],
        "webhook_increment_id" : 1,
        "event_timestamp": "2023-05-15T17:28:28+00:00"
    }
}

order:delivered

{
    "topic" : "order:delivered",
    "message" : {
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "shipments" : [
            {
              "unique_id" : "100000033",
              "warehouse_id": 1,
              "carrier": "fedex",
              "status" : "delivered",
              "service": "GROUND_HOME_DELIVERY",
              "trackers" : [{
                "tracker_id" : 4,
                "status" : "delivered",
                "carrier" : "fedex",
                "tracking_number" : "794657040105",
                "carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
                "est_delivery_at" : "2021-10-07T00:00:00-04:00",
                "is_est_delivery_at_date" : true,
                "original_est_delivery_at" : "2021-10-05T00:00:00-04:00",
                "is_original_est_delivery_at_date" : true,
                "delivered_at" : "2021-12-07T12:08:15-04:00",
                "signed_by" : "John Smith"
              }]
            }
        ],
        "webhook_increment_id" : 1,
        "event_timestamp": "2023-05-15T17:28:28+00:00"
    }
}

order:address_validation_failed

{
    "topic" : "order:address_validation_failed",
    "message" : {
        "unique_id" : "100000021",
        "order_ref" : "9099",
        "source" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

order:address_changed

{
    "topic" : "order:address_changed",
    "message" : {
        "unique_id" : "100000021",
        "order_ref" : "9099",
        "source" : null,
        "old_status" : "new",
        "status" : "new",
        "old_state" : "new",
        "state" : "new",
        "old_address" : {
            "firstname" : "John",
            "lastname" : "Doe",
            "company" : "ACME",
            "street" : "123 ACME BIG STREET",
            "city" : "New York",
            "region" : "NY",
            "postcode" : "99999",
            "country" : "US",
            "classification" : "com",
            "is_valid" : true,
            "telephone" : "865999999",
            "email" : "john.doe@example.com"
        },
        "address" : {
            "firstname" : "John",
            "lastname" : "Doe",
            "company" : "ACME",
            "street" : "321 ACME BIG STREET",
            "city" : "New York",
            "region" : "NY",
            "postcode" : "98765",
            "country" : "US",
            "classification" : "com",
            "is_valid" : true,
            "telephone" : "865999999",
            "email" : "john.doe@gmail.com"
        },
        "update_method" : "manual",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

order:status_changed

{
    "topic" : "order:status_changed",
    "message" : {
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "old_status" : null,
        "status" : "new",
        "old_state" : null,
        "state" : "new",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

order:shipments_updated

{
    "topic" : "order:shipments_updated",
    "message" : {
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "shipments" : [
            {
              "unique_id" : "100000033",
              "warehouse_id": 1,
              "carrier": "fedex",
              "service": "GROUND_HOME_DELIVERY"
            }
        ],
        "webhook_increment_id" : 1,
        "event_timestamp": "2023-05-15T17:28:28+00:00"
    }
}

order:shipping_options_changed

{
    "topic" : "order:shipping_options_changed",
    "message" : {
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "status" : "partial_backorder",
        "state" : "processing",
        "shipping_options" : {
            "saturday_delivery" : true
        },
        "old_shipping_options" : {
            "saturday_delivery" : false
        },
        "webhook_increment_id" : 1,
        "event_timestamp": "2023-05-15T17:28:28+00:00"
    }
}

product:created

{
    "topic" : "product:created",
    "message" : {
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

product:updated

{
    "topic" : "product:updated",
    "message" : {
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

product:sku_changed

{
    "topic" : "product:sku_changed",
    "message" : {
        "sku" : "product1",
        "external_id" : null,
        "old_sku": "344828-22",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

product:deleted

{
    "topic" : "product:deleted",
    "message" : {
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

product_media:created

{
    "topic" : "product_media:created",
    "message" : {
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 3,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

product_media:updated

{
    "topic" : "product_media:updated",
    "message" : {
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 3,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

product_media:deleted

{
    "topic" : "product_media:deleted",
    "message" : {
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 5,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery:created

{
    "topic" : "delivery:created",
    "message" : {
        "delivery_id" : 15,
        "delivery_type" : "rma",
        "increment_id" : "1000029",
        "sender_name" : "Microsoft",
        "sender_ref" : "00123456",
        "sender_ref_alt" : "abc123",
        "merchant_ref" : "xyz456",
        "merchant_status" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery:canceled

{
    "topic" : "delivery:canceled",
    "message" : {
        "delivery_id" : 16,
        "delivery_type" : "rma",
        "increment_id" : "1000030",
        "sender_name" : "Microsoft",
        "sender_ref" : "00123456",
        "sender_ref_alt" : "abc123",
        "merchant_ref" : "xyz456",
        "merchant_status" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery:accepted

{
    "topic" : "delivery:accepted",
    "message" : {
        "delivery_id" : 17,
        "delivery_type" : "rma",
        "increment_id" : "1000031",
        "sender_name" : "Microsoft",
        "sender_ref" : "00123456",
        "sender_ref_alt" : "abc123",
        "merchant_ref" : "xyz456",
        "merchant_status" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery:processed

{
    "topic" : "delivery:processed",
    "message" : {
        "delivery_id" : 18,
        "delivery_type" : "rma",
        "increment_id" : "1000032",
        "sender_name" : "Microsoft",
        "sender_ref" : "00123456",
        "sender_ref_alt" : "abc123",
        "merchant_ref" : "xyz456",
        "merchant_status" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery:exception

{
    "topic" : "delivery:exception",
    "message" : {
        "delivery_id" : 19,
        "delivery_type" : "rma",
        "increment_id" : "1000033",
        "sender_name" : "Microsoft",
        "sender_ref" : "00123456",
        "sender_ref_alt" : "abc123",
        "merchant_ref" : "xyz456",
        "merchant_status" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery:putaway

{
    "topic" : "delivery:putaway",
    "message" : {
        "delivery_id" : 20,
        "delivery_type" : "rma",
        "increment_id" : "1000034",
        "sender_name" : "Microsoft",
        "sender_ref" : "00123456",
        "sender_ref_alt" : "abc123",
        "merchant_ref" : "xyz456",
        "merchant_status" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery:committed

{
    "topic" : "delivery:committed",
    "message" : {
        "delivery_id" : 21,
        "delivery_type" : "rma",
        "increment_id" : "1000035",
        "sender_name" : "Microsoft",
        "sender_ref" : "00123456",
        "sender_ref_alt" : "abc123",
        "merchant_ref" : "xyz456",
        "merchant_status" : null,
        "stock_adjustments" : {
            "sku123" : {
                "sku" : "sku123",
                "external_id" : null,
                "product_id" : 7,
                "qty_adjust" : 5,
                "qty_available": 95,
                "qty_advertised": 95
            }
        },
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery:status_changed

{
    "topic" : "delivery:status_changed",
    "message" : {
        "delivery_id" : 22,
        "delivery_type" : "rma",
        "increment_id" : "1000036",
        "sender_name" : "Microsoft",
        "sender_ref" : "00123456",
        "sender_ref_alt" : "abc123",
        "merchant_ref" : "xyz456",
        "merchant_status" : null,
        "old_status" : "putting_away",
        "new_status" : "put_away",
        "old_state" : "putting_away",
        "new_state" : "complete",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery_label:created

{
    "topic" : "delivery_label:created",
    "message" : {
        "unique_id" : 5,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

delivery_label:voided

{
    "topic" : "delivery_label:voided",
    "message" : {
        "unique_id" : 7,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

import:created

{
    "topic" : "import:created",
    "message" : {
        "unique_id" : 4,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

import:completed

{
    "topic" : "import:completed",
    "message" : {
        "unique_id" : 5,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

inventory:adjusted

{
    "topic" : "inventory:adjusted",
    "message" : {
        "stock_adjustments" : {
            "sku123" : {
                "sku" : "sku123",
                "external_id" : null,
                "product_id" : 7,
                "qty_adjust" : 5,
                "qty_available": 95,
                "qty_advertised": 95
            }
        },
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

Stock adjustments will be included when a Bill of Material component is adjusted which affects a related products’ Virtual Inventory. Stock adjustments for changes invoked because of Virtual Inventory will not include the qty_adjust key, but rather only the absolute values.

shipment:packed

{
    "topic": "shipment:packed",
    "message": {
        "unique_id": "100000595",
        "warehouse_id": "1",
        "status": "packed",
        "external_id": null,
        "order_ref": null,
        "order_unique_id": "100000540",
        "source": null,
        "order_status": "complete",
        "carrier": "ups",
        "service": "03",
        "service_description": "UPS Ground",
        "items": [
            {
                "order_item_id": "2954",
                "order_item_ref": null,
                "order_item_sku": "556x45mm62FMJM855Fed-500",
                "sku": "556x45mm62FMJM855Fed-500",
                "quantity": "1.0000",
                "lot_data": [
                    {
                        "lot_number": "2021-01-01",
                        "expiration_date": "2021-01-01",
                        "origination_date": "2023-10-27",
                        "quantity": "1.0000"
                    }
                ]
            },
            {
                "order_item_id": "2955",
                "order_item_ref": null,
                "order_item_sku": "10mm200TMJCCI-1000",
                "sku": "10mm200TMJCCI-1000",
                "quantity": "1.0000",
                "lot_data": []
            }
        ],
        "packages": [
            {
                "package_id": "234",
                "status": "packed",
                "weight": "1.7500",
                "weight_unit": "lb",
                "tracker_id": "229",
                "items": [
                    {
                        "order_item_id": "2954",
                        "order_item_ref": null,
                        "order_item_sku": "556x45mm62FMJM855Fed-500",
                        "sku": "556x45mm62FMJM855Fed-500",
                        "quantity": "1.0000",
                        "order_item_qty": 1
                    }
                ],
                "package_data": [
                    {
                        "order_item_id": "2954",
                        "label": "Serial Number",
                        "value": "123456-3"
                    }
                ],
                "tracking_numbers": [
                    "TT234"
                ],
                "tracking_urls": [
                    "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT234"
                ],
                "packaging": []
            },
            {
                "package_id": "235",
                "status": "packed",
                "weight": "0.5000",
                "weight_unit": "lb",
                "tracker_id": "230",
                "items": [
                    {
                        "order_item_id": "2955",
                        "order_item_ref": null,
                        "order_item_sku": "10mm200TMJCCI-1000",
                        "sku": "10mm200TMJCCI-1000",
                        "quantity": "1.0000",
                        "order_item_qty": 1
                    }
                ],
                "package_data": [
                    {
                        "order_item_id": "2955",
                        "label": "Serial Number",
                        "value": "123456-5"
                    }
                ],
                "tracking_numbers": [
                    "TT235"
                ],
                "tracking_urls": [
                    "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT235"
                ],
                "packaging": []
            }
        ],
        "trackers": [
            {
                "tracker_id": "229",
                "status": "unknown",
                "carrier": "ups",
                "tracking_number": "TT234",
                "est_delivery_at": null,
                "is_est_delivery_at_date": null,
                "original_est_delivery_at": null,
                "is_original_est_delivery_at_date": null,
                "delivered_at": null,
                "signed_by": null,
                "carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT234"
            },
            {
                "tracker_id": "230",
                "status": "unknown",
                "carrier": "ups",
                "tracking_number": "TT235",
                "est_delivery_at": null,
                "is_est_delivery_at_date": null,
                "original_est_delivery_at": null,
                "is_original_est_delivery_at_date": null,
                "delivered_at": null,
                "signed_by": null,
                "carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT235"
            }
        ],
        "updated_at": "2023-10-27T11:59:09+00:00",
        "shipping_method": "ups_03",
        "tpb_group_id": null,
        "total_weight": 2.25,
        "total_qty": "2.0000",
        "order_id": "2542",
        "shipped_weight": null,
        "created_at": "2023-10-27T11:59:08+00:00",
        "target_ship_date": "2023-10-27",
        "packed_at": "2023-10-27T11:59:09+00:00",
        "total_item_weight": "2.2500",
        "scac": null,
        "shipped_at": null,
        "delivered_at": null,
        "store_code": "default",
        "total_weight_unit": "lb",
        "shipped_weight_unit": null,
        "webhook_increment_id": 3,
        "event_timestamp": "2023-10-27T11:59:09+00:00"
    }
}

shipment:shipped

{
    "topic": "shipment:shipped",
    "message": {
        "unique_id": "300000008",
        "warehouse_id": "1",
        "status": "shipped",
        "external_id": "123456",
        "order_ref": "456789",
        "order_unique_id": "400111867",
        "source": null,
        "order_status": "complete",
        "carrier": "ups",
        "service": "03",
        "service_description": "UPS Ground",
        "items": [
            {
                "order_item_id": "21",
                "order_item_ref": null,
                "order_item_sku": "12ga2-34buck00FederalPrem-250",
                "sku": "12ga2-34buck00FederalPrem-250",
                "quantity": "1.0000",
                "lot_data": []
            }
        ],
        "packages": [
            {
                "package_id": "1",
                "status": "shipped",
                "weight": "28.5000",
                "weight_unit": "lb",
                "tracker_id": "2",
                "items": [
                    {
                        "order_item_id": "21",
                        "order_item_ref": null,
                        "order_item_sku": "12ga2-34buck00FederalPrem-250",
                        "sku": "12ga2-34buck00FederalPrem-250",
                        "quantity": "1.0000",
                        "order_item_qty": 1
                    }
                ],
                "package_data": [],
                "tracking_numbers": [
                    "1Z999AA10123456784"
                ],
                "tracking_urls": [
                    "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z999AA10123456784"
                ],
                "packaging": []
            }
        ],
        "trackers": [
            {
                "tracker_id": "2",
                "status": "unknown",
                "carrier": "ups",
                "tracking_number": "1Z999AA10123456784",
                "est_delivery_at": null,
                "is_est_delivery_at_date": null,
                "original_est_delivery_at": null,
                "is_original_est_delivery_at_date": null,
                "delivered_at": null,
                "signed_by": null,
                "carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z999AA10123456784"
            }
        ],
        "updated_at": "2023-10-27T12:06:10+00:00",
        "shipping_method": "ups_03",
        "tpb_group_id": null,
        "total_weight": 26.7,
        "total_qty": "1.0000",
        "order_id": "17",
        "shipped_weight": 26.7,
        "created_at": "2013-02-28T20:18:04+00:00",
        "target_ship_date": null,
        "packed_at": null,
        "total_item_weight": "26.7000",
        "scac": null,
        "shipped_at": "2023-05-10T15:36:44+00:00",
        "delivered_at": null,
        "store_code": "default",
        "total_weight_unit": "lb",
        "shipped_weight_unit": "lb",
        "webhook_increment_id": 1,
        "event_timestamp": "2023-10-27T12:06:10+00:00"
    }
}

shipment:delivered

{
    "topic": "shipment:delivered",
    "message": {
        "unique_id": "300000008",
        "warehouse_id": "1",
        "status": "shipped",
        "external_id": "123456",
        "order_ref": "456789",
        "order_unique_id": "400111867",
        "source": null,
        "order_status": "complete",
        "carrier": "ups",
        "service": "03",
        "service_description": "UPS Ground",
        "items": [
            {
                "order_item_id": "21",
                "order_item_ref": null,
                "order_item_sku": "12ga2-34buck00FederalPrem-250",
                "sku": "12ga2-34buck00FederalPrem-250",
                "quantity": "1.0000",
                "lot_data": []
            }
        ],
        "packages": [
            {
                "package_id": "1",
                "status": "delivered",
                "weight": "28.5000",
                "weight_unit": "lb",
                "tracker_id": "3",
                "items": [
                    {
                        "order_item_id": "21",
                        "order_item_ref": null,
                        "order_item_sku": "12ga2-34buck00FederalPrem-250",
                        "sku": "12ga2-34buck00FederalPrem-250",
                        "quantity": "1.0000",
                        "order_item_qty": 1
                    }
                ],
                "package_data": [],
                "tracking_numbers": [
                    "1Z999AA10123456784"
                ],
                "tracking_urls": [
                    "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z999AA10123456784"
                ],
                "packaging": []
            }
        ],
        "trackers": [
            {
                "tracker_id": "3",
                "status": "delivered",
                "carrier": "ups",
                "tracking_number": "1Z999AA10123456784",
                "est_delivery_at": "2023-05-13T12:00:00-04:00",
                "is_est_delivery_at_date": false,
                "original_est_delivery_at": "2023-05-12T00:00:00-04:00",
                "is_original_est_delivery_at_date": true,
                "delivered_at": "2023-05-13T10:53:14-04:00",
                "signed_by": "J. Smith",
                "carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=1Z999AA10123456784"
            }
        ],
        "updated_at": "2023-10-27T12:09:45+00:00",
        "shipping_method": "ups_03",
        "tpb_group_id": null,
        "total_weight": 26.7,
        "total_qty": "1.0000",
        "order_id": "17",
        "shipped_weight": 26.7,
        "created_at": "2013-02-28T20:18:04+00:00",
        "target_ship_date": null,
        "packed_at": null,
        "total_item_weight": "26.7000",
        "scac": null,
        "shipped_at": "2023-05-10T21:42:17+00:00",
        "delivered_at": "2023-05-13T14:53:14+00:00",
        "store_code": "default",
        "total_weight_unit": "lb",
        "shipped_weight_unit": "lb",
        "webhook_increment_id": 1,
        "event_timestamp": "2023-10-27T12:09:45+00:00"
    }
}

shipment:reverted

{
    "topic": "shipment:reverted",
    "message": {
        "unique_id": "100000596",
        "warehouse_id": "1",
        "status": "voided",
        "external_id": null,
        "order_ref": null,
        "order_unique_id": "100000541",
        "source": null,
        "order_status": "backordered",
        "carrier": "ups",
        "service": "03",
        "service_description": "UPS Ground",
        "items": [
            {
                "order_item_id": "2956",
                "order_item_ref": null,
                "order_item_sku": "556x45mm62FMJM855Fed-500",
                "sku": "556x45mm62FMJM855Fed-500",
                "quantity": "1.0000",
                "lot_data": [
                    {
                        "lot_number": "2021-01-01",
                        "expiration_date": "2021-01-01",
                        "origination_date": "2023-10-27",
                        "quantity": "1.0000"
                    }
                ]
            },
            {
                "order_item_id": "2957",
                "order_item_ref": null,
                "order_item_sku": "10mm200TMJCCI-1000",
                "sku": "10mm200TMJCCI-1000",
                "quantity": "1.0000",
                "lot_data": []
            }
        ],
        "packages": [
            {
                "package_id": "236",
                "status": "packed",
                "weight": "1.7500",
                "weight_unit": "lb",
                "tracker_id": "231",
                "items": [
                    {
                        "order_item_id": "2956",
                        "order_item_ref": null,
                        "order_item_sku": "556x45mm62FMJM855Fed-500",
                        "sku": "556x45mm62FMJM855Fed-500",
                        "quantity": "1.0000",
                        "order_item_qty": 1
                    }
                ],
                "package_data": [
                    {
                        "order_item_id": "2956",
                        "label": "Serial Number",
                        "value": "123456-3"
                    }
                ],
                "tracking_numbers": [
                    "TT236"
                ],
                "tracking_urls": [
                    "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT236"
                ],
                "packaging": []
            },
            {
                "package_id": "237",
                "status": "packed",
                "weight": "0.5000",
                "weight_unit": "lb",
                "tracker_id": "232",
                "items": [
                    {
                        "order_item_id": "2957",
                        "order_item_ref": null,
                        "order_item_sku": "10mm200TMJCCI-1000",
                        "sku": "10mm200TMJCCI-1000",
                        "quantity": "1.0000",
                        "order_item_qty": 1
                    }
                ],
                "package_data": [
                    {
                        "order_item_id": "2957",
                        "label": "Serial Number",
                        "value": "123456-5"
                    }
                ],
                "tracking_numbers": [
                    "TT237"
                ],
                "tracking_urls": [
                    "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT237"
                ],
                "packaging": []
            }
        ],
        "trackers": [
            {
                "tracker_id": "231",
                "status": "unknown",
                "carrier": "ups",
                "tracking_number": "TT236",
                "est_delivery_at": null,
                "is_est_delivery_at_date": null,
                "original_est_delivery_at": null,
                "is_original_est_delivery_at_date": null,
                "delivered_at": null,
                "signed_by": null,
                "carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT236"
            },
            {
                "tracker_id": "232",
                "status": "unknown",
                "carrier": "ups",
                "tracking_number": "TT237",
                "est_delivery_at": null,
                "is_est_delivery_at_date": null,
                "original_est_delivery_at": null,
                "is_original_est_delivery_at_date": null,
                "delivered_at": null,
                "signed_by": null,
                "carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT237"
            }
        ],
        "updated_at": "2023-10-27T12:12:53+00:00",
        "shipping_method": "ups_03",
        "tpb_group_id": null,
        "total_weight": 2.25,
        "total_qty": "2.0000",
        "order_id": "2543",
        "shipped_weight": null,
        "created_at": "2023-10-27T12:12:50+00:00",
        "target_ship_date": "2023-10-27",
        "packed_at": "2023-10-27T12:12:51+00:00",
        "total_item_weight": "2.2500",
        "scac": null,
        "shipped_at": null,
        "delivered_at": null,
        "store_code": "default",
        "total_weight_unit": "lb",
        "shipped_weight_unit": null,
        "webhook_increment_id": 4,
        "event_timestamp": "2023-10-27T12:12:53+00:00"
    }
}

shipment:labels_voided

{
    "topic": "shipment:labels_voided",
    "message": {
        "unique_id": "100000597",
        "warehouse_id": "1",
        "status": "picked",
        "external_id": null,
        "order_ref": null,
        "order_unique_id": "100000542",
        "source": null,
        "order_status": "processing",
        "carrier": "ups",
        "service": "03",
        "service_description": "UPS Ground",
        "packages": [
            {
                "package_id": "238",
                "status": "packed",
                "weight": "1.7500",
                "weight_unit": "lb",
                "tracker_id": "233",
                "items": [
                    {
                        "order_item_id": "2958",
                        "order_item_ref": null,
                        "order_item_sku": "556x45mm62FMJM855Fed-500",
                        "sku": "556x45mm62FMJM855Fed-500",
                        "quantity": "1.0000",
                        "order_item_qty": 1
                    }
                ],
                "package_data": [
                    {
                        "order_item_id": "2958",
                        "label": "Serial Number",
                        "value": "123456-3"
                    }
                ],
                "tracking_numbers": [
                    "TT238"
                ],
                "tracking_urls": [
                    "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT238"
                ],
                "packaging": []
            },
            {
                "package_id": "239",
                "status": "packed",
                "weight": "0.5000",
                "weight_unit": "lb",
                "tracker_id": "234",
                "items": [
                    {
                        "order_item_id": "2959",
                        "order_item_ref": null,
                        "order_item_sku": "10mm200TMJCCI-1000",
                        "sku": "10mm200TMJCCI-1000",
                        "quantity": "1.0000",
                        "order_item_qty": 1
                    }
                ],
                "package_data": [
                    {
                        "order_item_id": "2959",
                        "label": "Serial Number",
                        "value": "123456-5"
                    }
                ],
                "tracking_numbers": [
                    "TT239"
                ],
                "tracking_urls": [
                    "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT239"
                ],
                "packaging": []
            }
        ],
        "trackers": [
            {
                "tracker_id": "233",
                "status": "unknown",
                "carrier": "ups",
                "tracking_number": "TT238",
                "est_delivery_at": null,
                "is_est_delivery_at_date": null,
                "original_est_delivery_at": null,
                "is_original_est_delivery_at_date": null,
                "delivered_at": null,
                "signed_by": null,
                "carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT238"
            },
            {
                "tracker_id": "234",
                "status": "unknown",
                "carrier": "ups",
                "tracking_number": "TT239",
                "est_delivery_at": null,
                "is_est_delivery_at_date": null,
                "original_est_delivery_at": null,
                "is_original_est_delivery_at_date": null,
                "delivered_at": null,
                "signed_by": null,
                "carrier_tracking_url": "https://wwwapps.ups.com/tracking/tracking.cgi?tracknum=TT239"
            }
        ],
        "updated_at": "2023-10-27T12:18:06+00:00",
        "shipping_method": "ups_03",
        "tpb_group_id": null,
        "total_weight": 2.25,
        "total_qty": "2.0000",
        "order_id": "2544",
        "shipped_weight": null,
        "created_at": "2023-10-27T12:18:04+00:00",
        "target_ship_date": "2023-10-27",
        "packed_at": null,
        "total_item_weight": "2.2500",
        "scac": null,
        "shipped_at": null,
        "delivered_at": null,
        "store_code": "default",
        "total_weight_unit": "lb",
        "shipped_weight_unit": null,
        "webhook_increment_id": 2,
        "event_timestamp": "2023-10-27T12:18:06+00:00"
    }
}

package:packed

{
    "topic" : "package:packed",
    "message" : {
        "package_id" : 22,
        "status" : "packed",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

package:manifested

{
    "topic" : "package:manifested",
    "message" : {
        "package_id" : 22,
        "status" : "manifested",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

package:shipped

{
    "topic" : "package:shipped",
    "message" : {
        "package_id" : 22,
        "status" : "shipped",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

package:delivered

{
    "topic" : "package:delivered",
    "message" : {
        "package_id" : 22,
        "status" : "delivered",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

track:created

This topic is deprecated. Please use shipment:packed instead.

{
    "topic" : "track:created",
    "message" : {
        "order_ref" : "9099",
        "order_unique_id" : "100000018",
        "shipment_unique_id" : "100000007",
        "warehouse_id": 1,
        "package_id" : 99,
        "source" : "shopify",
        "carrier" : "fedex",
        "service" : "FEDEX_2_DAY",
        "number" : "794657040105",
        "url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

tracker:updated

{
    "topic" : "tracker:updated",
    "message" : {
        "tracker_id" : 23,
        "order_unique_id" : "100000018",
        "order_ref" : "9099",
        "order_source" : "shopify",
        "shipment_unique_id" : "100000007",
        "warehouse_id" : 1,
        "carrier" : "fedex",
        "tracking_number" : "794657040105",
        "carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
        "old_status" : "unknown",
        "new_status" : "pre_transit",
        "new_details" : [{
            "status" : "pre_transit",
            "timestamp" : "2021-12-03T12:08:15-04:00",
            "is_timestamp_date" : false,
            "message" : "Label created.",
            "source" : "carrier_api",
            "location" : {
                "city" : "Amsterdam",
                "country" : "US",
                "postcode" : "12010-6269",
                "region" : "NY",
                "timezone" : "America/New_York",
                "lat" : 42.9387,
                "lng" : -74.1882
            }
        }],
        "est_delivery_at" : "2021-10-05T00:00:00-04:00",
        "is_est_delivery_at_date" : true,
        "original_est_delivery_at" : "2021-10-05T00:00:00-04:00",
        "is_original_est_delivery_at_date" : true,
        "delivered_at" : null,
        "signed_by" : null,
        "packages" : [{
            "package_id" : 99,
            "weight" : 10.2,
            "weight_unit" : "lb",
            "tracker_id" : 3,
            "items" : [
                {"order_item_id" : "443313", "sku" : "sku123", "quantity" : 1}
            ],
            "package_data" : [
                {"order_item_id" : "443313", "label" : "Serial Number - 8 Characters", "value" : "55285442"}
            ],
            "tracking_numbers" : [
                "794657040105"
            ],
            "tracking_urls" : [
                "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105"
            ],
            "packaging" : []
        }],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-03T16:08:15+00:00"
    }
}

tracker:delivered

{
    "topic" : "tracker:delivered",
    "message" : {
        "tracker_id" : 23,
        "order_unique_id" : "100000018",
        "order_ref" : "9099",
        "order_source" : "shopify",
        "shipment_unique_id" : "100000007",
        "warehouse_id" : 1,
        "carrier" : "fedex",
        "tracking_number" : "794657040105",
        "carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
        "old_status" : "out_for_delivery",
        "new_status" : "delivered",
        "new_details" : [{
            "status" : "delivered",
            "message" : "Delivered at front door.",
            "timestamp" : "2021-12-07T12:08:15-04:00",
            "is_timestamp_date" : false,
            "source" : "carrier_api",
            "location" : {
                "city" : "Amsterdam",
                "country" : "US",
                "postcode" : "12010-6269",
                "region" : "NY",
                "timezone" : "America/New_York",
                "lat" : 42.9387,
                "lng" : -74.1882
            }
        }],
        "est_delivery_at" : "2021-10-05T00:00:00-04:00",
        "is_est_delivery_at_date" : true,
        "original_est_delivery_at" : "2021-10-05T00:00:00-04:00",
        "is_original_est_delivery_at_date" : true,
        "delivered_at" : "2021-12-07T12:08:15-04:00",
        "signed_by" : "J. Smith",
        "packages" : [{
            "package_id" : 99,
            "weight" : 10.2,
            "weight_unit" : "lb",
            "tracker_id" : 3,
            "items" : [
                {"order_item_id" : "443313", "sku" : "sku123", "quantity" : 1}
            ],
            "package_data" : [
                {"order_item_id" : "443313", "label" : "Serial Number - 8 Characters", "value" : "55285442"}
            ],
            "tracking_numbers" : [
                "794657040105"
            ],
            "tracking_urls" : [
                "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105"
            ],
            "packaging" : []
        }],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

tracker:exception

{
    "topic" : "tracker:exception",
    "message" : {
        "tracker_id" : 23,
        "order_unique_id" : "100000018",
        "order_ref" : "9099",
        "order_source" : "shopify",
        "shipment_unique_id" : "100000007",
        "warehouse_id" : 1,
        "carrier" : "fedex",
        "tracking_number" : "794657040105",
        "carrier_tracking_url" : "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105",
        "old_status" : "out_for_delivery",
        "new_status" : "return_to_sender",
        "new_details" : [{
            "status" : "return_to_sender",
            "message" : "Refused by customer.",
            "timestamp" : "2021-12-07T12:08:15-04:00",
            "is_timestamp_date" : false,
            "source" : "carrier_api",
            "location" : {
                "city" : "Amsterdam",
                "country" : "US",
                "postcode" : "12010-6269",
                "region" : "NY",
                "timezone" : "America/New_York",
                "lat" : 42.9387,
                "lng" : -74.1882
            }
        }],
        "packages" : [{
            "package_id" : 99,
            "weight" : 10.2,
            "weight_unit" : "lb",
            "tracker_id" : 3,
            "items" : [
                {"order_item_id" : "443313", "sku" : "sku123", "quantity" : 1}
            ],
            "package_data" : [
                {"order_item_id" : "443313", "label" : "Serial Number - 8 Characters", "value" : "55285442"}
            ],
            "tracking_numbers" : [
                "794657040105"
            ],
            "tracking_urls" : [
                "https://www.fedex.com/apps/fedextrack/?action=track&tracknumbers=794657040105"
            ],
            "packaging" : []
        }],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

manifest:sealed

{
    "topic" : "manifest:sealed",
    "message" : {
        "manifest_id" : 3,
        "warehouse_id" : 1,
        "carrier" : "ups",
        "weight" : 45,
        "weight_unit" : "lb",
        "orders" : [{
            "unique_id" : "100000021",
            "order_ref" : null,
            "state" : "complete",
            "source" : "sps:test:123:8ZC3:544",
            "tracking_numbers" : [
                "794657040105"
            ]
        }],
        "shipments" : [{
            "unique_id" : "100000035",
            "order_ref" : null,
            "order_unique_id" : "100000021",
            "source" : "123456",
            "status" : "packed"
        }],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}

manifest:loaded

{
    "topic" : "manifest:loaded",
    "message" : {
        "manifest_id" : 3,
        "warehouse_id" : 1,
        "carrier" : "ups",
        "weight" : 45,
        "weight_unit" : "lb",
        "orders" : [{
            "unique_id" : "100000021",
            "order_ref" : null,
            "state" : "complete",
            "source" : "sps:test:123:8ZC3:544",
            "tracking_numbers" : [
                "794657040105"
            ]
        }],
        "shipments" : [{
            "unique_id" : "100000035",
            "order_ref" : null,
            "order_unique_id" : "100000021",
            "source" : "123456",
            "status" : "packed"
        }],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}