> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstream.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Webhook Topics

This page lists the available topics to specify when subscribing to [Webhooks](https://docs.shipstream.io/merchant-api/webhook.md) 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.

Some payload fields contain **Protected Customer Data (PCD)** — personal information such as customer
names, addresses, phone numbers, and email addresses. These fields are only included when the webhook
subscription has **Include PCD** enabled; otherwise they are omitted.

## Event Payloads

### `delivery:created`

```json title="Payload" theme={null}
{
    "topic" : "delivery:created",
    "message" : {
        "merchant_code" : "acme",
        "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"
    }
}
```

> [!NOTE]
>
> `sender_name` contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has **Include PCD** enabled.

### `delivery:canceled`

```json title="Payload" theme={null}
{
    "topic" : "delivery:canceled",
    "message" : {
        "merchant_code" : "acme",
        "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"
    }
}
```

> [!NOTE]
>
> `sender_name` contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has **Include PCD** enabled.

### `delivery:accepted`

```json title="Payload" theme={null}
{
    "topic" : "delivery:accepted",
    "message" : {
        "merchant_code" : "acme",
        "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"
    }
}
```

> [!NOTE]
>
> `sender_name` contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has **Include PCD** enabled.

### `delivery:processed`

```json title="Payload" theme={null}
{
    "topic" : "delivery:processed",
    "message" : {
        "merchant_code" : "acme",
        "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"
    }
}
```

> [!NOTE]
>
> `sender_name` contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has **Include PCD** enabled.

### `delivery:exception`

```json title="Payload" theme={null}
{
    "topic" : "delivery:exception",
    "message" : {
        "merchant_code" : "acme",
        "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"
    }
}
```

> [!NOTE]
>
> `sender_name` contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has **Include PCD** enabled.

### `delivery:putaway`

```json title="Payload" theme={null}
{
    "topic" : "delivery:putaway",
    "message" : {
        "merchant_code" : "acme",
        "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"
    }
}
```

> [!NOTE]
>
> `sender_name` contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has **Include PCD** enabled.

### `delivery:committed`

```json title="Payload" theme={null}
{
    "topic" : "delivery:committed",
    "message" : {
        "merchant_code" : "acme",
        "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" : {
            "MINT-12" : {
                "sku" : "MINT-12",
                "external_id" : null,
                "product_id" : 7,
                "qty_adjust" : 12,
                "qty_available" : 102,
                "qty_advertised" : 102,
                "details" : [
                    {
                        "lot_id" : 67,
                        "qty_adjust" : "12.0000"
                    }
                ]
            }
        },
        "closed_at" : "2026-07-13T09:08:40+00:00",
        "containers" : [
            {
                "container_id" : 31,
                "delivery_id" : 21,
                "container_type_id" : 1,
                "damage_type" : "none",
                "weight_discrepancy" : "none",
                "tare_weight" : 5,
                "weighed_at" : "2026-07-13T09:08:38+00:00",
                "weighed_by" : 12,
                "notes" : "Inbound pallet",
                "weight" : 33,
                "tare_weight_unit" : "lb",
                "weight_unit" : "lb",
                "contents" : [
                    {
                        "delivery_item_id" : 44,
                        "qty_counted" : "12.0000",
                        "qty_shortage" : "0.0000",
                        "lots" : [
                            {
                                "lot_id" : 67,
                                "qty_counted" : "12.0000",
                                "qty_shortage" : "0.0000",
                                "qty_processed" : "12.0000",
                                "qty_putaway" : "12.0000",
                                "qty_committed" : "12.0000"
                            }
                        ]
                    }
                ]
            }
        ],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2026-07-13T09:08:40+00:00"
    }
}
```

The `containers` property is included on every `delivery:committed` and `delivery:complete` event, although the array can be empty. Each entry follows the existing [Delivery Container Properties](https://docs.shipstream.io/merchant-api/delivery.md#container-properties) structure.

> [!NOTE]
>
> The webhook payload is generated asynchronously shortly after the event occurs, so `containers` is a snapshot of the delivery's committed state at generation time — not the exact instant the event fired. Changes made in that brief window (for example, an overage exception approved right after commit) are reflected in the payload, so it may not byte-match a `delivery.search` response captured at a different moment.

> [!NOTE]
>
> Non-lot content returns `lots: []`. Container content and lot quantity values are formatted decimal strings, such as `"12.0000"`. For lot-tracked content, webhook lot entries add `qty_processed`, `qty_putaway`, and `qty_committed` to `lot_id`, `qty_counted`, and `qty_shortage`. These three commit quantities are webhook-only and are not added to the `delivery.search` container lot response. A pending overage-only lot is omitted while all of its reported quantities are zero; after the overage is approved, the lot can appear with its processed quantity.

> [!NOTE]
>
> `sender_name` contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has **Include PCD** enabled.

### `delivery:complete`

`delivery:complete` uses the same enriched container snapshot as `delivery:committed`. Its existing header does not include `delivery_type`.

```json title="Payload" theme={null}
{
    "topic" : "delivery:complete",
    "message" : {
        "merchant_code" : "acme",
        "delivery_id" : 21,
        "increment_id" : "1000035",
        "sender_name" : "Microsoft",
        "sender_ref" : "00123456",
        "sender_ref_alt" : "abc123",
        "merchant_ref" : "xyz456",
        "merchant_status" : null,
        "stock_adjustments" : [],
        "closed_at" : "2026-07-13T09:08:40+00:00",
        "containers" : [
            {
                "container_id" : 31,
                "delivery_id" : 21,
                "container_type_id" : 1,
                "damage_type" : "none",
                "weight_discrepancy" : "none",
                "tare_weight" : 5,
                "weighed_at" : "2026-07-13T09:08:38+00:00",
                "weighed_by" : 12,
                "notes" : "Inbound pallet",
                "weight" : 33,
                "tare_weight_unit" : "lb",
                "weight_unit" : "lb",
                "contents" : [
                    {
                        "delivery_item_id" : 44,
                        "qty_counted" : "12.0000",
                        "qty_shortage" : "0.0000",
                        "lots" : [
                            {
                                "lot_id" : 67,
                                "qty_counted" : "12.0000",
                                "qty_shortage" : "0.0000",
                                "qty_processed" : "12.0000",
                                "qty_putaway" : "12.0000",
                                "qty_committed" : "12.0000"
                            }
                        ]
                    }
                ]
            }
        ],
        "webhook_increment_id" : 2,
        "event_timestamp" : "2026-07-13T09:08:40+00:00"
    }
}
```

> [!NOTE]
>
> `sender_name` contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has **Include PCD** enabled.

### `delivery:status_changed`

```json title="Payload" theme={null}
{
    "topic" : "delivery:status_changed",
    "message" : {
        "merchant_code" : "acme",
        "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"
    }
}
```

> [!NOTE]
>
> `sender_name` contains Protected Customer Data (PCD) for RMA deliveries and is only included when the webhook subscription has **Include PCD** enabled.

### `delivery_label:created`

```json title="Payload" theme={null}
{
    "topic" : "delivery_label:created",
    "message" : {
        "merchant_code" : "acme",
        "unique_id" : 5,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `delivery_label:voided`

```json title="Payload" theme={null}
{
    "topic" : "delivery_label:voided",
    "message" : {
        "merchant_code" : "acme",
        "unique_id" : 7,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `import:created`

```json title="Payload" theme={null}
{
    "topic" : "import:created",
    "message" : {
        "merchant_code" : "acme",
        "unique_id" : 4,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `import:completed`

```json title="Payload" theme={null}
{
    "topic" : "import:completed",
    "message" : {
        "merchant_code" : "acme",
        "unique_id" : 5,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `inventory:adjusted`

```json title="Payload" theme={null}
{
    "topic" : "inventory:adjusted",
    "message" : {
        "merchant_code" : "acme",
        "stock_adjustments" : {
            "sku123" : {
                "sku" : "sku123",
                "external_id" : null,
                "product_id" : 7,
                "qty_adjust" : "5.0000",
                "qty_available": 95,
                "qty_advertised": 95,
                "details" : [
                    {
                        "lot_id" : 123,
                        "qty_adjust" : "10.0000",
                        "adjustment_reason_code" : "found"
                    },
                    {
                        "lot_id" : 124,
                        "qty_adjust" : "-6.0000",
                        "hold_reason_code" : "quality_review",
                        "qty_held" : "6.0000"
                    },
                    {
                        "lot_id" : null,
                        "qty_adjust" : "1.0000"
                    }
                ]
            }
        },
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

Stock adjustments are also included when adjusting a Bill of Materials (BOM) component changes a related product's virtual inventory. Adjustments caused only by virtual inventory omit `qty_adjust` and include only absolute values.

#### Stock adjustment details

The optional `details` array breaks `qty_adjust` down by lot and adjustment or hold reason. The same structure can appear in `inventory:adjusted`, `delivery:committed`, and `delivery:complete` payloads, as well as other topics that include `stock_adjustments`.

| Field | Type | Description |
| - | - | - |
| `lot_id` | integer or null | The ShipStream lot ID. A null value represents quantity that is not attributed to a lot. Lot numbers, expiration dates, and other lot metadata are not included. |
| `qty_adjust` | string | The quantity attributed to this detail, formatted to four decimal places. |
| `adjustment_reason_code` | string | The inventory adjustment reason. This field and `hold_reason_code` are mutually exclusive. |
| `hold_reason_code` | string or null | The inventory hold reason. This field and `adjustment_reason_code` are mutually exclusive. |
| `qty_held` | string | The held-quantity change. This field appears only on hold or release details. |

Details use `(lot_id, reason namespace, reason code)` as their aggregation key. The reason namespace is either `adjustment_reason_code` or `hold_reason_code`. Entries with the same key are combined. Entries for different lots or reasons remain separate, even when they offset one another, and a keyed entry remains present when its combined `qty_adjust` is `0.0000`.

When `details` is present, the sum of every detail's `qty_adjust` equals the stock adjustment's top-level `qty_adjust`. ShipStream adds a null-lot, reasonless detail when it needs to represent a residual quantity. If an adjustment has no lot or reason breakdown, `details` is omitted.

### `inventory:advertised_changed`

Sent after a committed transaction changes the advertised quantity of one or more products. Use this topic to synchronize the quantity available for sale without inferring advertised inventory changes from order, delivery, hold, or adjustment events.

```json title="Payload" theme={null}
{
    "topic" : "inventory:advertised_changed",
    "message" : {
        "merchant_code" : "acme",
        "changes" : [
            {
                "product_id" : 7,
                "sku" : "sku123",
                "external_id" : null,
                "qty_advertised_was" : 100,
                "qty_advertised" : 94,
                "warehouses" : [
                    {
                        "warehouse_id" : 1,
                        "qty_advertised_was" : 60,
                        "qty_advertised" : 54
                    }
                ],
                "holds" : [
                    {
                        "hold_id" : 321,
                        "action" : "placed",
                        "reason_code" : "quality_review",
                        "lot_id" : 123,
                        "lot_number" : "LOT-2026-001",
                        "warehouse_id" : 1,
                        "qty_available" : "-6.0000",
                        "qty_held" : "6.0000"
                    }
                ]
            }
        ],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2026-08-06T10:15:30+00:00"
    }
}
```

Each change reports the first captured quantity and the final quantity for one product in the transaction. Intermediate changes are combined. A transaction that finishes with no net advertised quantity change at either the merchant or warehouse level does not emit this topic.

The `changes` array contains up to 500 products. A transaction that changes more than 500 products produces multiple webhook events.

#### Advertised inventory change fields

| Field | Type | Description |
| - | - | - |
| `product_id` | integer | The internal product ID. |
| `sku` | string | The product SKU. |
| `external_id` | string or null | The merchant-supplied external product ID, or `null` when one is not set. |
| `qty_advertised_was` | integer or null | The merchant-level advertised quantity before the transaction. This is `null` when the advertised inventory record was created by the transaction. |
| `qty_advertised` | integer | The merchant-level advertised quantity after the transaction. |
| `warehouses` | array | The warehouses whose advertised quantity changed. The array is empty when only the merchant-level quantity changed. |
| `holds` | array | Hold operations associated with the advertised quantity change. |

The merchant-level quantity can remain unchanged while warehouse quantities change, such as when inventory moves between warehouses. In that case, `qty_advertised_was` and `qty_advertised` are equal, and `warehouses` identifies each changed warehouse.

#### Warehouse change fields

| Field | Type | Description |
| - | - | - |
| `warehouse_id` | integer | The internal warehouse ID. |
| `qty_advertised_was` | integer or null | The warehouse's advertised quantity before the transaction. This is `null` when the advertised inventory record was created by the transaction. |
| `qty_advertised` | integer | The warehouse's advertised quantity after the transaction. |

#### Hold context fields

The optional `holds` array describes hold placements and releases that occurred in the same transaction and affected the product's advertised quantity.

| Field | Type | Description |
| - | - | - |
| `hold_id` | integer | The internal inventory hold ID. |
| `action` | string | The hold operation: `placed` or `released`. |
| `reason_code` | string | The parent [hold reason](https://docs.shipstream.io/merchant-api/inventory.md#hold-reason-properties) code. User-defined sub-reasons are reported as their parent reason code. |
| `lot_id` | integer or null | The internal ID of the lot attributed to the affected inventory, or `null` when the inventory is not attributed to a lot. |
| `lot_number` | string or null | The lot number, or `null` when the inventory is not attributed to a lot. |
| `warehouse_id` | integer | The internal warehouse ID where the hold was placed or released. |
| `qty_available` | string | The available-quantity change caused by the hold operation, formatted to four decimal places. A placement is negative, and a release is positive. |
| `qty_held` | string | The signed held-quantity change, formatted to four decimal places. A placement is positive, and a release is negative. |

#### Event boundaries and attribution

Each committed inventory transaction is reported independently. One API request or warehouse operation can therefore produce multiple events when it commits an inventory change and then recalculates virtual inventory in a follow-up transaction.

The `holds` array is contributing context rather than a complete inventory-change audit. It includes hold placements and releases when that context is available to the transaction. Advertised changes caused by allocation, reallocation, Work Orders, or virtual-inventory calculations do not include hold or Lot attribution. The `lot_id` and `lot_number` fields identify a contributing hold; they do not represent per-Lot advertised quantities.

### `inventory:hold_changed`

Sent when inventory holds are placed or released. An inventory hold freezes inventory in place so that it is excluded from the available quantity. It is not a quantity movement, so this topic reports lifecycle transitions only. Use `inventory:adjusted`, `inventory:advertised_changed`, and the inventory polling APIs for quantity changes.

```json title="Payload" theme={null}
{
    "topic" : "inventory:hold_changed",
    "message" : {
        "merchant_code" : "acme",
        "transaction_id" : "9f1c4b6a2d7e40c8b3a5f6091d2e8c74",
        "chunk_index" : 1,
        "chunk_count" : 1,
        "changes" : [
            {
                "action" : "placed",
                "status" : "active",
                "scope_type" : "lot",
                "product_id" : 7,
                "sku" : "sku123",
                "external_id" : null,
                "warehouse_id" : null,
                "lot_id" : 41,
                "lot_number" : "2024-05-01",
                "reason" : {
                    "code" : "damaged",
                    "label" : "Damaged",
                    "display_group" : "Hold",
                    "parent_code" : null
                },
                "hold_reason_code" : "damaged",
                "parent_hold_id" : null,
                "release_cause" : null,
                "hold_ids" : [ 5012 ]
            },
            {
                "action" : "placed",
                "status" : "active",
                "scope_type" : "location",
                "product_id" : 7,
                "sku" : "sku123",
                "external_id" : null,
                "warehouse_id" : 1,
                "lot_id" : 41,
                "lot_number" : "2024-05-01",
                "reason" : {
                    "code" : "damaged",
                    "label" : "Damaged",
                    "display_group" : "Hold",
                    "parent_code" : null
                },
                "hold_reason_code" : "damaged",
                "parent_hold_id" : 5012,
                "release_cause" : null,
                "hold_ids" : [ 5013, 5014, 5015 ]
            }
        ],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2026-09-02T10:15:30+00:00"
    }
}
```

Each `changes` entry aggregates holds that made the same transition for the same product, warehouse, lot, reason, scope, parent hold, and release cause. One operation that holds many locations therefore produces one change instead of one change per location. Individual slot identity is not exposed. The affected hold audit row IDs are listed in `hold_ids` in ascending order.

#### Inventory hold change fields

| Field | Type | Description |
| - | - | - |
| `merchant_code` | string | Code of the merchant whose inventory hold changed. |
| `transaction_id` | string | Random identifier shared by every message produced for one merchant by one committed operation. |
| `chunk_index` | integer | 1-based position of this message within the committed operation. |
| `chunk_count` | integer | Total number of messages produced for the committed operation. Reconstruct the logical order with `chunk_index` rather than delivery order, which is not guaranteed across retries. |
| `changes` | array | Aggregated hold lifecycle transitions. Across one message, the sum of the `hold_ids` array lengths in all changes never exceeds 500. |
| `action` | string | The transition: `placed` or `released`. |
| `status` | string | Absolute state after the transition: `active` or `released`. |
| `scope_type` | string | `location` for a hold on a specific location, or `lot` for the lot-wide sentinel that keeps a whole lot held. |
| `product_id` | integer | Internal ID of the product to which the hold applies. |
| `sku` | string | SKU of the product to which the hold applies. |
| `external_id` | string or null | Merchant-supplied external product ID, or `null` when one is not set. |
| `warehouse_id` | integer or null | Internal warehouse ID, or `null` for a `lot` scope hold that spans warehouses. |
| `lot_id` | integer or null | Internal lot ID, or `null` when the inventory is not lot tracked. |
| `lot_number` | string or null | Lot number, or `null` when the inventory is not lot tracked. |
| `reason` | object | Selected hold reason, including its `code`, display `label`, `display_group`, and `parent_code`. |
| `reason.code` | string | Code of the selected hold reason. |
| `reason.label` | string | Display label of the selected hold reason. Do not use this editable field for branching logic. |
| `reason.display_group` | string | Display group of the selected hold reason. Do not use this editable field for branching logic. |
| `reason.parent_code` | string or null | Code of the selected reason's parent, or `null` when it has no parent. |
| `hold_reason_code` | string | Parent reason code for a child reason, otherwise the same value as `reason.code`. |
| `parent_hold_id` | integer or null | Persisted parent hold ID, or `null`. A lot sentinel is the parent of the location holds it spreads to. This is durable lineage; use `transaction_id` to group changes created by one operation. |
| `release_cause` | string or null | Cause of a `released` transition: `explicit`, `drain`, `reconcile`, or `superseded`. This is `null` for `placed`. |
| `hold_ids` | array | Sorted, de-duplicated IDs of the hold audit rows that made this transition. |

A hold that is both placed and released within one operation produces two ordered changes. Changes are not merged across different parent holds or release causes, so each entry describes one unambiguous transition.

### `order:created`

```json title="Payload" theme={null}
{
    "topic" : "order:created",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000015",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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"
        },
        "stock_adjustments" : {
            "sku123" : {
                "sku" : "sku123",
                "external_id" : null,
                "product_id" : 7,
                "qty_adjust" : -5,
                "qty_available": 95,
                "qty_advertised": 95
            }
        },
        "items" : [
            {
                "sku" : "product1",
                "name" : "product1",
                "qty_ordered" : "2.0000",
                "qty_backordered" : "0.0000",
                "qty_canceled" : "0.0000",
                "qty_processing" : "0.0000",
                "qty_shipped" : "0.0000",
                "unit_declared_value" : null,
                "unit_declared_value_currency" : "USD",
                "unit_customs_value" : null,
                "unit_customs_value_currency" : "USD",
                "gift_message" : null,
                "weight" : "5.800000",
                "row_weight" : "11.600000",
                "allocation_data" : [
                    {
                        "warehouse_id" : "2",
                        "qty_allocated" : "2.0000"
                    }
                ],
                "order_item_id" : "230",
                "order_item_ref" : null,
                "weight_unit" : "lb",
                "row_weight_unit" : "lb"
            },
            {
                "sku" : "product3",
                "name" : "product3",
                "qty_ordered" : "7.0000",
                "qty_backordered" : "1.0000",
                "qty_canceled" : "0.0000",
                "qty_processing" : "0.0000",
                "qty_shipped" : "0.0000",
                "unit_declared_value" : null,
                "unit_declared_value_currency" : "USD",
                "gift_message" : null,
                "unit_customs_value" : null,
                "unit_customs_value_currency" : "USD",
                "weight" : "0.200000",
                "row_weight" : "1.400000",
                "allocation_data" : [
                    {
                        "warehouse_id" : "1",
                        "qty_allocated" : "2.0000"
                    },
                    {
                        "warehouse_id" : "2",
                        "qty_allocated" : "4.0000"
                    }
                ],
                "order_item_id" : "232",
                "order_item_ref" : null,
                "weight_unit" : "lb",
                "row_weight_unit" : "lb"
            }
        ],
        "webhook_increment_id" : 2,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:canceled`

```json title="Payload" theme={null}
{
    "topic" : "order:canceled",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000016",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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"
        },
        "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"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:items_updated`

Sent when items of an order are canceled or have a cancellation requested. Also sent alongside `order:canceled` when canceling all items of an order leaves its packed shipments with pending cancellation requests instead of canceling them. The requested quantities are listed under `items_canceled`, as when canceling specific SKUs. Repeating the cancellation when nothing more can be canceled or requested does not send this event again.

```json title="Payload" theme={null}
{
    "topic": "order:items_updated",
    "message": {
        "merchant_code": "acme",
        "brand_code": "default",
        "unique_id": "100000022",
        "order_ref": "9099",
        "source": null,
        "shipping_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"
        },
        "items_canceled": [
            {
                "sku": "product1",
                "order_item_id": "215",
                "qty_canceled": "1.0000"
            }
        ],
        "items_remaining": [
            {
                "sku": "product2",
                "name": "product2",
                "qty_ordered": "1.0000",
                "qty_backordered": "0.0000",
                "qty_canceled": "0.0000",
                "qty_processing": "0.0000",
                "qty_shipped": "1.0000",
                "unit_declared_value": null,
                "unit_declared_value_currency": "USD",
                "unit_customs_value": null,
                "unit_customs_value_currency": "USD",
                "weight": "5.800000",
                "row_weight": "5.800000",
                "package_data": [
                    {
                        "label": "Serial Number - 8 Characters",
                        "value": "12345ABC"
                    }
                ],
                "allocation_data": [
                    {
                        "warehouse_id": "2",
                        "qty_allocated": "0.0000"
                    }
                ],
                "order_item_id": "214",
                "order_item_ref": null,
                "weight_unit": "lb",
                "row_weight_unit": "lb"
            }
        ],
        "webhook_increment_id": 1,
        "event_timestamp": "2021-12-07T16:08:15+00:00"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:holded`

```json title="Payload" theme={null}
{
    "topic" : "order:holded",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000017",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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"
        },
        "webhook_increment_id" : 3,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:completed`

Sent when the order's status becomes `complete`. This normally happens when the last outstanding shipment ships, not when it is packed, and the order's `completed_at` is set at the same time. If the order returns to `packed`, for example when a package is removed from a manifest, `completed_at` is cleared and this event is sent again when the order completes again.

```json title="Payload" theme={null}
{
    "topic" : "order:completed",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000020",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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"
        },
        "webhook_increment_id" : 5,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:shipped`

```json title="Payload" theme={null}
{
    "topic" : "order:shipped",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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"
        },
        "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"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:delivered`

```json title="Payload" theme={null}
{
    "topic" : "order:delivered",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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"
        },
        "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" : "J. Smith"
              }]
            }
        ],
        "webhook_increment_id" : 1,
        "event_timestamp": "2023-05-15T17:28:28+00:00"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:address_validation_failed`

```json title="Payload" theme={null}
{
    "topic" : "order:address_validation_failed",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000021",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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" : false,
            "telephone" : "865999999",
            "email" : "john.doe@example.com"
        },
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:address_changed`

```json title="Payload" theme={null}
{
    "topic" : "order:address_changed",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "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"
    }
}
```

> [!NOTE]
>
> `old_address` and `address` contain Protected Customer Data (PCD) and are only included when the webhook subscription has **Include PCD** enabled.

### `order:status_changed`

Sent whenever the order's status changes. After packing, an order typically moves from `processing` to `packed` (state `processing`), then from `packed` to `complete` when its last outstanding shipment ships. A carrier that marks shipments shipped during packing can move the order directly to `complete`. If a shipped shipment returns to Packed, the order moves back from `complete` to `packed`.

```json title="Payload" theme={null}
{
    "topic" : "order:status_changed",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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"
        },
        "old_status" : null,
        "status" : "new",
        "old_state" : null,
        "state" : "new",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:shipments_updated`

```json title="Payload" theme={null}
{
    "topic" : "order:shipments_updated",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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"
        },
        "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"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `order:shipping_options_changed`

```json title="Payload" theme={null}
{
    "topic" : "order:shipping_options_changed",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "unique_id" : "100000022",
        "order_ref" : "9099",
        "source" : null,
        "shipping_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"
        },
        "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"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `product:created`

```json title="Payload" theme={null}
{
    "topic" : "product:created",
    "message" : {
        "merchant_code" : "acme",
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `product:updated`

```json title="Payload" theme={null}
{
    "topic" : "product:updated",
    "message" : {
        "merchant_code" : "acme",
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `product:sku_changed`

```json title="Payload" theme={null}
{
    "topic" : "product:sku_changed",
    "message" : {
        "merchant_code" : "acme",
        "sku" : "product1",
        "external_id" : null,
        "old_sku": "344828-22",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `product:deleted`

```json title="Payload" theme={null}
{
    "topic" : "product:deleted",
    "message" : {
        "merchant_code" : "acme",
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `product_media:created`

```json title="Payload" theme={null}
{
    "topic" : "product_media:created",
    "message" : {
        "merchant_code" : "acme",
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 3,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `product_media:updated`

```json title="Payload" theme={null}
{
    "topic" : "product_media:updated",
    "message" : {
        "merchant_code" : "acme",
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 3,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `product_media:deleted`

```json title="Payload" theme={null}
{
    "topic" : "product_media:deleted",
    "message" : {
        "merchant_code" : "acme",
        "sku" : "product1",
        "external_id" : null,
        "webhook_increment_id" : 5,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `serial_number:created`

```json title="Payload" theme={null}
{
    "topic" : "serial_number:created",
    "message" : {
        "merchant_code" : "acme",
        "serial_id" : 234,
        "identifier" : "123456123456",
        "product_id" : 7,
        "sku" : "sku123",
        "created_at" : "2024-10-22T16:08:15+00:00",
        "warehouse_id" : 1,
        "old_status" : "unknown",
        "new_status" : "received",
        "old_availability" : "checked_out",
        "new_availability" : "pending",
        "old_location" : null,
        "old_location_id" : null,
        "new_location" : null,
        "new_location_id" : null,
        "target_type" : "asn",
        "target_id" : 15,
        "target_description" : "1000029",
        "target_child_type" : "container",
        "target_child_id" : 16,
        "target_child_description" : "Pallet 1",
        "package_id" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2024-10-22T16:08:15+00:00"
    }
}
```

### `serial_number:updated`

```json title="Payload" theme={null}
{
    "topic" : "serial_number:updated",
    "message" : {
        "merchant_code" : "acme",
        "serial_id" : 234,
        "identifier" : "123456123456",
        "product_id" : 7,
        "sku" : "sku123",
        "created_at" : "2024-10-22T16:08:15+00:00",
        "warehouse_id" : 1,
        "old_status" : "received",
        "new_status" : "located",
        "old_availability" : "pending",
        "new_availability" : "available",
        "old_location" : null,
        "old_location_id" : null,
        "new_location" : "A-2",
        "new_location_id" : 224,
        "target_type" : "asn",
        "target_id" : 15,
        "target_description" : "1000029",
        "target_child_type" : "container",
        "target_child_id" : 16,
        "target_child_description" : "Pallet 1",
        "package_id" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2024-10-22T16:45:13+00:00"
    }
}
```

### `serial_number:checkin`

```json title="Payload" theme={null}
{
    "topic" : "serial_number:checkin",
    "message" : {
        "merchant_code" : "acme",
        "serial_id" : 234,
        "identifier" : "123456123456",
        "product_id" : 7,
        "sku" : "sku123",
        "created_at" : "2024-10-22T16:08:15+00:00",
        "warehouse_id" : 1,
        "old_status" : "unknown",
        "new_status" : "received",
        "old_availability" : "checked_out",
        "new_availability" : "pending",
        "old_location" : null,
        "old_location_id" : null,
        "new_location" : null,
        "new_location_id" : null,
        "target_type" : "asn",
        "target_id" : 15,
        "target_description" : "1000029",
        "target_child_type" : "container",
        "target_child_id" : 16,
        "target_child_description" : "Pallet 1",
        "package_id" : null,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2024-10-22T16:08:15+00:00"
    }
}
```

### `serial_number:checkout`

```json title="Payload" theme={null}
{
    "topic" : "serial_number:checkout",
    "message" : {
        "merchant_code" : "acme",
        "serial_id" : 234,
        "identifier" : "123456123456",
        "product_id" : 7,
        "sku" : "sku123",
        "created_at" : "2024-10-22T16:08:15+00:00",
        "warehouse_id" : 1,
        "old_status" : "packed",
        "new_status" : "shipped",
        "old_availability" : "pending",
        "new_availability" : "checked_out",
        "old_location" : null,
        "old_location_id" : null,
        "new_location" : null,
        "new_location_id" : null,
        "target_type" : "order",
        "target_id" : 15,
        "target_description" : "1000029",
        "target_child_type" : "shipment",
        "target_child_id" : 16,
        "target_child_description" : "1000042",
        "package_id" : 48,
        "webhook_increment_id" : 1,
        "event_timestamp" : "2024-10-23T09:22:26+00:00"
    }
}
```

> [!NOTE]
>
> The `packages[]` payload in the `shipment:*` and `tracker:*` events mirrors the package shape returned by [`shipment.info`](https://docs.shipstream.io/merchant-api/shipment#shipment-info) — see [Package Properties](https://docs.shipstream.io/merchant-api/shipment.md#package-properties) for the full reference. For `items[].lot_data[]`, see the Lot Data fields under [Shipment Item Properties](https://docs.shipstream.io/merchant-api/shipment.md#shipment-item-properties). `manifest_courier_code` is included only when the shipment has a manifest code.

### `shipment:packed`

Use this topic to respond to packing. When packing finishes the order's fulfillment work, `order_status` is `packed`; the order becomes `complete` only when its shipments ship. If the shipment is marked shipped automatically during packing, this event is not sent and [`shipment:shipped`](#shipmentshipped) is sent instead, so subscribe to both topics to cover every packed shipment.

```json title="Payload" theme={null}
{
    "topic": "shipment:packed",
    "message": {
        "merchant_code": "acme",
        "brand_code": "default",
        "unique_id": "100000595",
        "warehouse_id": "1",
        "status": "packed",
        "external_id": null,
        "order_ref": null,
        "order_unique_id": "100000540",
        "source": null,
        "order_status": "packed",
        "carrier": "ups",
        "service": "03",
        "service_description": "UPS Ground",
        "shipping_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"
        },
        "items": [
            {
                "order_item_id": "2954",
                "order_item_ref": null,
                "order_item_sku": "556x45mm62FMJM855Fed-500",
                "sku": "556x45mm62FMJM855Fed-500",
                "quantity": "1.0000",
                "lot_data": [
                    {
                        "lot_id": 456,
                        "sku": "556x45mm62FMJM855Fed-500",
                        "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",
                "created_at": "2023-10-27T11:59:08+00:00",
                "tracking_added_at": "2023-10-27T11:59:09+00:00",
                "shipped_at": null,
                "delivered_at": null,
                "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": [],
                "manifest_courier": "UPS",
                "carrier": "ups",
                "manifest_courier_code": "ups",
                "billable_weight": "14",
                "billable_weight_unit": "lb",
                "dimensional_weight_divisor": "139",
                "dimensional_weight_divisor_unit": "in^3/lb",
                "dimensional_weight": "14",
                "rating_weight_unit": "lb",
                "dimensions": {
                    "length": "16.000",
                    "width": "12.000",
                    "height": "8.000"
                },
                "dimension_unit": "in",
                "sscc": "00508101336500131005",
                "serial_number_data": [
                    {
                        "serial_id": "1",
                        "identifier": "123456123456",
                        "sku": "556x45mm62FMJM855Fed-500",
                        "product_id": "7"
                    }
                ]
            },
            {
                "package_id": "235",
                "status": "packed",
                "weight": "0.5000",
                "weight_unit": "lb",
                "tracker_id": "230",
                "created_at": "2023-10-27T11:59:08+00:00",
                "tracking_added_at": "2023-10-27T11:59:09+00:00",
                "shipped_at": null,
                "delivered_at": null,
                "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": [],
                "manifest_courier": "UPS",
                "carrier": "ups",
                "manifest_courier_code": "ups",
                "billable_weight": "14",
                "billable_weight_unit": "lb",
                "dimensional_weight_divisor": "139",
                "dimensional_weight_divisor_unit": "in^3/lb",
                "dimensional_weight": "14",
                "rating_weight_unit": "lb",
                "dimensions": {
                    "length": "16.000",
                    "width": "12.000",
                    "height": "8.000"
                },
                "dimension_unit": "in",
                "sscc": "00508101336500131005",
                "serial_number_data": [
                    {
                        "serial_id": "1",
                        "identifier": "123456123456",
                        "sku": "10mm200TMJCCI-1000",
                        "product_id": "7"
                    }
                ]
            }
        ],
        "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"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `shipment:shipped`

```json title="Payload" theme={null}
{
    "topic": "shipment:shipped",
    "message": {
        "merchant_code": "acme",
        "brand_code": "default",
        "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",
        "shipping_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"
        },
        "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",
                "created_at": "2013-02-28T20:18:04+00:00",
                "tracking_added_at": "2023-05-10T15:36:44+00:00",
                "shipped_at": "2023-05-10T15:36:44+00:00",
                "delivered_at": null,
                "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": [],
                "manifest_courier": "UPS",
                "carrier": "ups",
                "manifest_courier_code": "ups",
                "billable_weight": "14",
                "billable_weight_unit": "lb",
                "dimensional_weight_divisor": "139",
                "dimensional_weight_divisor_unit": "in^3/lb",
                "dimensional_weight": "14",
                "rating_weight_unit": "lb",
                "dimensions": {
                    "length": "16.000",
                    "width": "12.000",
                    "height": "8.000"
                },
                "dimension_unit": "in",
                "sscc": "00508101336500131005",
                "serial_number_data": [
                    {
                        "serial_id": "1",
                        "identifier": "123456123456",
                        "sku": "12ga2-34buck00FederalPrem-250",
                        "product_id": "7"
                    }
                ]
            }
        ],
        "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"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `shipment:delivered`

```json title="Payload" theme={null}
{
    "topic": "shipment:delivered",
    "message": {
        "merchant_code": "acme",
        "brand_code": "default",
        "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",
        "shipping_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"
        },
        "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",
                "created_at": "2013-02-28T20:18:04+00:00",
                "tracking_added_at": "2023-05-10T21:42:17+00:00",
                "shipped_at": "2023-05-10T21:42:17+00:00",
                "delivered_at": "2023-05-13T14:53:14+00:00",
                "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": [],
                "manifest_courier": "UPS",
                "carrier": "ups",
                "manifest_courier_code": "ups",
                "billable_weight": "14",
                "billable_weight_unit": "lb",
                "dimensional_weight_divisor": "139",
                "dimensional_weight_divisor_unit": "in^3/lb",
                "dimensional_weight": "14",
                "rating_weight_unit": "lb",
                "dimensions": {
                    "length": "16.000",
                    "width": "12.000",
                    "height": "8.000"
                },
                "dimension_unit": "in",
                "sscc": "00508101336500131005",
                "serial_number_data": [
                    {
                        "serial_id": "1",
                        "identifier": "123456123456",
                        "sku": "12ga2-34buck00FederalPrem-250",
                        "product_id": "7"
                    }
                ]
            }
        ],
        "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"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `shipment:reverted`

```json title="Payload" theme={null}
{
    "topic": "shipment:reverted",
    "message": {
        "merchant_code": "acme",
        "brand_code": "default",
        "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",
        "shipping_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"
        },
        "items": [
            {
                "order_item_id": "2956",
                "order_item_ref": null,
                "order_item_sku": "556x45mm62FMJM855Fed-500",
                "sku": "556x45mm62FMJM855Fed-500",
                "quantity": "1.0000",
                "lot_data": [
                    {
                        "lot_id": 456,
                        "sku": "556x45mm62FMJM855Fed-500",
                        "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",
                "created_at": "2023-10-27T12:12:50+00:00",
                "tracking_added_at": "2023-10-27T12:12:51+00:00",
                "shipped_at": null,
                "delivered_at": null,
                "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": [],
                "manifest_courier": "UPS",
                "carrier": "ups",
                "manifest_courier_code": "ups",
                "billable_weight": "14",
                "billable_weight_unit": "lb",
                "dimensional_weight_divisor": "139",
                "dimensional_weight_divisor_unit": "in^3/lb",
                "dimensional_weight": "14",
                "rating_weight_unit": "lb",
                "dimensions": {
                    "length": "16.000",
                    "width": "12.000",
                    "height": "8.000"
                },
                "dimension_unit": "in",
                "sscc": "00508101336500131005",
                "serial_number_data": [
                    {
                        "serial_id": "1",
                        "identifier": "123456123456",
                        "sku": "556x45mm62FMJM855Fed-500",
                        "product_id": "7"
                    }
                ]
            },
            {
                "package_id": "237",
                "status": "packed",
                "weight": "0.5000",
                "weight_unit": "lb",
                "tracker_id": "232",
                "created_at": "2023-10-27T12:12:50+00:00",
                "tracking_added_at": "2023-10-27T12:12:51+00:00",
                "shipped_at": null,
                "delivered_at": null,
                "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": [],
                "manifest_courier": "UPS",
                "carrier": "ups",
                "manifest_courier_code": "ups",
                "billable_weight": "14",
                "billable_weight_unit": "lb",
                "dimensional_weight_divisor": "139",
                "dimensional_weight_divisor_unit": "in^3/lb",
                "dimensional_weight": "14",
                "rating_weight_unit": "lb",
                "dimensions": {
                    "length": "16.000",
                    "width": "12.000",
                    "height": "8.000"
                },
                "dimension_unit": "in",
                "sscc": "00508101336500131005",
                "serial_number_data": [
                    {
                        "serial_id": "1",
                        "identifier": "123456123456",
                        "sku": "10mm200TMJCCI-1000",
                        "product_id": "7"
                    }
                ]
            }
        ],
        "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"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `shipment:labels_voided`

```json title="Payload" theme={null}
{
    "topic": "shipment:labels_voided",
    "message": {
        "merchant_code": "acme",
        "brand_code": "default",
        "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",
        "shipping_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"
        },
        "packages": [
            {
                "package_id": "238",
                "status": "packed",
                "weight": "1.7500",
                "weight_unit": "lb",
                "tracker_id": "233",
                "created_at": "2023-10-27T12:18:04+00:00",
                "tracking_added_at": "2023-10-27T12:18:04+00:00",
                "shipped_at": null,
                "delivered_at": null,
                "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": [],
                "manifest_courier": "UPS",
                "carrier": "ups",
                "manifest_courier_code": "ups",
                "billable_weight": "14",
                "billable_weight_unit": "lb",
                "dimensional_weight_divisor": "139",
                "dimensional_weight_divisor_unit": "in^3/lb",
                "dimensional_weight": "14",
                "rating_weight_unit": "lb",
                "dimensions": {
                    "length": "16.000",
                    "width": "12.000",
                    "height": "8.000"
                },
                "dimension_unit": "in",
                "sscc": "00508101336500131005",
                "serial_number_data": [
                    {
                        "serial_id": "1",
                        "identifier": "123456123456",
                        "sku": "556x45mm62FMJM855Fed-500",
                        "product_id": "7"
                    }
                ]
            },
            {
                "package_id": "239",
                "status": "packed",
                "weight": "0.5000",
                "weight_unit": "lb",
                "tracker_id": "234",
                "created_at": "2023-10-27T12:18:04+00:00",
                "tracking_added_at": "2023-10-27T12:18:04+00:00",
                "shipped_at": null,
                "delivered_at": null,
                "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": [],
                "manifest_courier": "UPS",
                "carrier": "ups",
                "manifest_courier_code": "ups",
                "billable_weight": "14",
                "billable_weight_unit": "lb",
                "dimensional_weight_divisor": "139",
                "dimensional_weight_divisor_unit": "in^3/lb",
                "dimensional_weight": "14",
                "rating_weight_unit": "lb",
                "dimensions": {
                    "length": "16.000",
                    "width": "12.000",
                    "height": "8.000"
                },
                "dimension_unit": "in",
                "sscc": "00508101336500131005",
                "serial_number_data": [
                    {
                        "serial_id": "1",
                        "identifier": "123456123456",
                        "sku": "10mm200TMJCCI-1000",
                        "product_id": "7"
                    }
                ]
            }
        ],
        "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"
    }
}
```

> [!NOTE]
>
> `shipping_address` contains Protected Customer Data (PCD) and is only included when the webhook subscription has **Include PCD** enabled.

### `package:packed`

```json title="Payload" theme={null}
{
    "topic" : "package:packed",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "package_id" : 22,
        "status" : "packed",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `package:manifested`

```json title="Payload" theme={null}
{
    "topic" : "package:manifested",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "package_id" : 22,
        "status" : "manifested",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `package:shipped`

```json title="Payload" theme={null}
{
    "topic" : "package:shipped",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "package_id" : 22,
        "status" : "shipped",
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `package:delivered`

```json title="Payload" theme={null}
{
    "topic" : "package:delivered",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "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](#shipmentpacked) instead.

This event is sent when a package's tracking number or alternate tracking number is set or changed. It is not sent when a tracking number is removed, for example when a label is voided.

```json title="Payload" theme={null}
{
    "topic" : "track:created",
    "message" : {
        "merchant_code" : "acme",
        "brand_code" : "default",
        "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`

```json title="Payload" theme={null}
{
    "topic" : "tracker:updated",
    "message" : {
        "merchant_code" : "acme",
        "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,
            "created_at" : "2021-12-03T16:08:15+00:00",
            "tracking_added_at" : "2021-12-03T16:08:15+00:00",
            "shipped_at" : null,
            "delivered_at" : null,
            "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" : [],
            "manifest_courier" : "FedEx",
            "carrier" : "fedex",
            "manifest_courier_code" : "fedex",
            "billable_weight" : "14",
            "billable_weight_unit" : "lb",
            "dimensional_weight_divisor" : "139",
            "dimensional_weight_divisor_unit" : "in^3/lb",
            "dimensional_weight" : "14",
            "rating_weight_unit" : "lb",
            "dimensions" : {
                "length" : "16.000",
                "width" : "12.000",
                "height" : "8.000"
            },
            "dimension_unit" : "in",
            "sscc" : "00508101336500131005",
            "serial_number_data" : [
                {
                    "serial_id" : "1",
                    "identifier" : "123456123456",
                    "sku" : "sku123",
                    "product_id" : "7"
                }
            ]
        }],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-03T16:08:15+00:00"
    }
}
```

### `tracker:delivered`

```json title="Payload" theme={null}
{
    "topic" : "tracker:delivered",
    "message" : {
        "merchant_code" : "acme",
        "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,
            "created_at" : "2021-12-03T16:08:15+00:00",
            "tracking_added_at" : "2021-12-03T16:08:15+00:00",
            "shipped_at" : "2021-12-06T16:08:15+00:00",
            "delivered_at" : "2021-12-07T12:08:15-04:00",
            "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" : [],
            "manifest_courier" : "FedEx",
            "carrier" : "fedex",
            "manifest_courier_code" : "fedex",
            "billable_weight" : "14",
            "billable_weight_unit" : "lb",
            "dimensional_weight_divisor" : "139",
            "dimensional_weight_divisor_unit" : "in^3/lb",
            "dimensional_weight" : "14",
            "rating_weight_unit" : "lb",
            "dimensions" : {
                "length" : "16.000",
                "width" : "12.000",
                "height" : "8.000"
            },
            "dimension_unit" : "in",
            "sscc" : "00508101336500131005",
            "serial_number_data" : [
                {
                    "serial_id" : "1",
                    "identifier" : "123456123456",
                    "sku" : "sku123",
                    "product_id" : "7"
                }
            ]
        }],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `tracker:exception`

```json title="Payload" theme={null}
{
    "topic" : "tracker:exception",
    "message" : {
        "merchant_code" : "acme",
        "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,
            "created_at" : "2021-12-03T16:08:15+00:00",
            "tracking_added_at" : "2021-12-03T16:08:15+00:00",
            "shipped_at" : null,
            "delivered_at" : null,
            "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" : [],
            "manifest_courier" : "FedEx",
            "carrier" : "fedex",
            "manifest_courier_code" : "fedex",
            "billable_weight" : "14",
            "billable_weight_unit" : "lb",
            "dimensional_weight_divisor" : "139",
            "dimensional_weight_divisor_unit" : "in^3/lb",
            "dimensional_weight" : "14",
            "rating_weight_unit" : "lb",
            "dimensions" : {
                "length" : "16.000",
                "width" : "12.000",
                "height" : "8.000"
            },
            "dimension_unit" : "in",
            "sscc" : "00508101336500131005",
            "serial_number_data" : [
                {
                    "serial_id" : "1",
                    "identifier" : "123456123456",
                    "sku" : "sku123",
                    "product_id" : "7"
                }
            ]
        }],
        "webhook_increment_id" : 1,
        "event_timestamp" : "2021-12-07T16:08:15+00:00"
    }
}
```

### `manifest:sealed`

```json title="Payload" theme={null}
{
    "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`

```json title="Payload" theme={null}
{
    "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"
    }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.