Shipment Webhooks

Shipment webhooks notify you when fulfillment and shipping status changes. Each webhook includes shipment details with tracking information, carrier data, and customer billing and shipping addresses. Use these webhooks to update third-party fulfillment systems with shipment status, sync delivery information with warehouse management software, push shipment data to business intelligence platforms for carrier performance analysis, and track the complete fulfillment lifecycle from scheduled to delivered. These webhooks are essential for maintaining accurate shipping records across multiple systems.

Events

shipment_shipped - Package marked as shipped
shipment_cancelled - Shipment cancelled
shipment_fulfilled - Shipment fulfilled

Trigger Conditions

Sent when shipment status changes (delivered every 5 minutes)
Includes tracking information when available
Can be triggered by fulfillment integrations or manual updates

Webhook Payload

The webhook includes shipment details with tracking information, carrier data, and associated customer addresses.

Nested Data

The shipment webhook includes:

customer_address_billing - Billing address
customer_address_shipping - Shipping address
campaign - Campaign information

Example Payload

{
  "webhook_type": "shipment",
  "webhook_event": "shipment_shipped",
  "webhook_event_id": 6900,
  "webhook_event_date": "2025-09-30 18:46:25",
  "webhook_data": {
    "shipment": {
      "id": "248065",
      "customer_id": "28614314",
      "order_id": "60583153",
      "shipment_prepaid_cycle": "0",
      "shipment_status_id": "Shipped",
      "transaction_charge_id": "977585",
      "fulfillment_id": null,
      "shipment_tracking_id": "123456",
      "carrier_id": null,
      "shipping_profile_id": null,
      "date_cancel": "0000-00-00 00:00:00",
      "date_scheduled": "2022-02-03 14:09:32",
      "date_complete": "2022-02-16 00:00:00",
      "date_scan": "0000-00-00 00:00:00",
      "date_deliver": "0000-00-00 00:00:00",
      "date_return": "0000-00-00 00:00:00",
      "customer_address_billing": {
        "customer_address_id": "78578",
        "fname": "john",
        "lname": "test",
        "address1": "Test street",
        "city": "Test",
        "state": "CO",
        "zipcode": "12345",
        "address_valid": "1"
      },
      "customer_address_shipping": {
        "customer_address_id": "78578",
        "fname": "john",
        "lname": "test",
        "address1": "Test street",
        "city": "Test",
        "state": "CO",
        "zipcode": "12345",
        "address_valid": "1"
      },
      "campaign": {
        "campaign_id": "69",
        "campaign_name": "Campaign TEST"
      }
    }
  }
}