About webhooks for the order lifecycle

The Pack App can send webhook notifications to your system to keep you updated on the status of your orders. These webhooks are sent out at key moments in the order lifecycle, allowing you to build powerful integrations and automate your workflows.

This document guides you through the steps to register your organization's webhook. To start, you’ll need to access the Pack App in the Shipium Console.

One webhook registered per application to be notified with order lifecycle event updates

Your organization can use a Shipium webhook to receive order lifecycle event updates to one API endpoint (or application), and then manage those updates via your internal processing system or pass them to your internal customers.

For example, if you have customers A, B, and C that need to receive order lifecycle event updates automatically, you would register one Shipium webhook for Customer A, one for Customer B, and one for Customer C, with three unique API endpoints.

🎣

One webhook per application to be notified with updates

Shipium suggests creating one webhook per desired application for which your organization needs to receive tracking event updates.

Once you've registered your organization's webhook, you can disable, delete, and enable it via the Pack App in the Shipium Console. You also can view a summary of all your registered webhooks within the console.

Steps to register your webhook

To receive these webhook notifications, you will need to configure a webhook endpoint in your Shipium account settings. Please contact your Shipium account manager for assistance with setting up your webhooks.

Order lifecycle event types for your webhook

The following table includes the event metadata event types that can be returned for an order lifecycle event notification. Each event type needs its own webhook registration; however, you can point all registered webhooks at the same API.

Final steps and sample webhook call content

This section provides instructions for responding successfully to your webhook's initial call as well as sample webhook messages as they would appear as incoming order lifecycle event updates.

How to respond to your first webhook call

Once you've successfully registered your organization's webhook, you will start receiving webhook calls. Upon receipt of your webhook call, you'll need to respond with an appropriate Hypertext Transfer Protocol (HTTP) status code to acknowledge successful receipt of your webhook call. Your response must:

• be an HTTP status code within the 200-299 range; and
• be delivered within 3 seconds of receiving the webhook call.

Shipium's automated response to your newly registered webhook

Once you've registered your organization's webhook, Shipium:

• will retry the webhook three times if a 200-level HTTP code response is not received within 3 seconds, as required;
• will log this as an error; and
• may decide to mark your API endpoint as broken if multiple errors are received.

Webhook retry logic

If a webhook push fails to deliver to the target location, the Shipium platform employs automated retry logic. This is not the same as guaranteed delivery of webhooks. If your organization’s system or webhook endpoint is down for an extended period, retries may not deliver the payload. Our webhooks have the below retry/backoff policy for new webhook setups. We will configure separate policies if there are recurring performance issues with a managed endpoint we are publishing to.

Backoff Policy for Webhooks

• Maximum Delivery Attempt Count = 4
• Backoffs per Attempt:
  • Attempt #1 = No backoff
  • Attempt #2 Backoff = 1 hour
  • Attempt #3 Backoff = 4 hours
  • Attempt #4 Backoff = 16 hours
• Maximum Backoff Time/Expires After = 24 hours

Sample webhook messages

This section provides sample expected webhook messages as they would appear when delivering order lifecycle event updates.

This sample JavaScript Object Notation (JSON) message demonstrates the push event sent to your organization's endpoint for your registered webhook. When a webhook is published regarding an order lifecycle event, it will contain an array with one or more updates.

"events": [ // List of events
      {
          "metadata": { // The metadata associated with this event
              "eventId": "string", // UUID identifying this event for debugging/idempotency purposes
              "eventTimestamp": "date-time", // UTC timestamp of when this event was generated in our system
              "eventType": "string", // Indicates what event occurred in our system
              "payloadSchemaVersion": "string", // The schema version of this event's payload (major)
              "testEvent": boolean // Indicates if this is a test notification instead of a real event
          },
          "payload": { // The actual event data associated with this event
            // eventType specific payload 
          }
      }
  ]

The elements in the above sample webhook message are described in the following table.

Sample webhook message for order created or order updated event

This sample JSON message demonstrates the example model of the push event for the order create and order update event types sent to your organization's endpoint for your registered webhook. The same payload is used for the order create and order update event types.

{
  "eventId": "a1b2c3d4-e5f6-7g8h-9i0j-k1l2m3n4o5p6",
  "eventType": "order_created",
  "tenantId": "7b9c8d6e-5f4a-4321-b0c9-8e7f6a5b4c3d",
  "shipiumOrderId": "ord_2b4a6c8e-1f3d-5b7f-9h1j-3k5m7o9q1s3u",
  "partnerOrderId": "ACME-ORDER-789456",
  "orderStatus": "created",
  "orderEventDateTime": "2025-09-22T15:30:45.123Z",
  "fulfillmentType": "dropship",
  "orderSource": "store",
  "associatedIdentifiers": [
    "ACME-INTERNAL-12345",
    "CAMPAIGN-FALL2025"
  ],
  "orderedDateTime": "2025-09-22T15:29:12.456Z",
  "orderItemQuantities": [
    {
      "productId": "SKU-WIDGET-001",
      "quantity": 2
    },
    {
      "productId": "SKU-GADGET-XL-BLUE",
      "quantity": 1
    }
  ],
  "shipFromAddress": {
    "name": "ACME Fulfillment Center",
    "addressLine1": "1500 Industrial Blvd",
    "addressLine2": "Suite 200",
    "city": "Las Vegas",
    "region": "NV",
    "postalCode": "89408",
    "countryCode": "US",
    "addressType": "commercial",
    "phoneNumber": "+1-555-123-4567"
  },
  "originId": "warehouse_lv_01",
  "destinationAddress": {
    "name": "John Smith",
    "addressLine1": "123 Ocean Drive",
    "addressLine2": "Apt 4B",
    "city": "Miami",
    "region": "FL", 
    "postalCode": "33131",
    "countryCode": "US",
    "addressType": "residential",
    "phoneNumber": "+1-555-987-6543",
    "email": "[email protected]"
  },
  "shipOption": "ground",
  "customsInfo": {
    "contentType": "merchandise",
    "contentDescription": "Electronic accessories",
    "incoterm": "DAP",
    "customsItems": [
      {
        "description": "Wireless charging widget",
        "quantity": 2,
        "unitValue": {
          "amount": 29.99,
          "currencyCode": "USD"
        },
        "weight": {
          "value": 0.5,
          "unit": "lb"
        },
        "hsCode": "8504.40.95",
        "countryOfOrigin": "CN"
      }
    ]
  },
  "currencyCode": "USD",
  "totalDeclaredValue": {
    "amount": 89.97,
    "currencyCode": "USD"
  },
  "orderFulfillmentParameters": {
    "priorityLevel": "standard",
    "packagingPreference": "minimal",
    "deliveryInstructions": "Leave at front door",
    "insuranceRequired": false,
    "signatureRequired": false,
    "saturdayDelivery": false,
    "expeditedProcessing": false
  }
}

Sample webhook message for order shipped event

This sample JSON message demonstrates the example model of the push event for the order shipped event type sent to your organization's endpoint for your registered webhook.

{
  "eventId": "f3e7b8c2-9d1a-4f6e-8b2c-5d7f9a1e3b6d",
  "eventType": "order_shipped",
  "tenantId": "7b9c8d6e-5f4a-4321-b0c9-8e7f6a5b4c3d",
  "shipiumOrderId": "ord_2b4a6c8e-1f3d-5b7f-9h1j-3k5m7o9q1s3u",
  "partnerOrderId": "ACME-ORDER-789456",
  "orderStatus": "partially_shipped",
  "orderEventDateTime": "2025-09-23T10:15:32.789Z",
  "shipiumShipmentId": "ship_8a2f4e6b-3c5d-7f9a-1e3b-5d7f9a1e3b6d",
  "partnerShipmentId": "ACME-SHIP-789456-001",
  "type": "forward",
  "carrierTrackingId": "1Z999AA1234567890",
  "carrier": "ups",
  "carrierServiceMethodId": "ups-ground-service-method-id",
  "shipFromAddress": {
    "name": "ACME Fulfillment Center",
    "addressLine1": "1500 Industrial Blvd",
    "addressLine2": "Suite 200",
    "city": "Las Vegas",
    "region": "NV",
    "postalCode": "89408",
    "countryCode": "US",
    "addressType": "commercial",
    "phoneNumber": "+1-555-123-4567"
  },
  "originId": "warehouse_lv_01",
  "destinationAddress": {
    "name": "John Smith",
    "addressLine1": "123 Ocean Drive",
    "addressLine2": "Apt 4B",
    "city": "Miami",
    "region": "FL",
    "postalCode": "33131",
    "countryCode": "US",
    "addressType": "residential",
    "phoneNumber": "+1-555-987-6543",
    "email": "[email protected]"
  },
  "fulfillmentContext": "warehouse",
  "fulfillmentContextId": "9ba10640-600a-4d3e-842f-4b6a6c535be6",
  "packagingType": {
    "packagingMaterial": "box",
    "linearDimensions": {
      "linearUnit": "in",
      "length": 12.0,
      "width": 9.0,
      "height": 6.0
    }
  },
  "totalWeight": {
    "weightUnit": "lb",
    "weight": 1.8
  },
  "shippedOrderItemQuantities": [
    {
      "productId": "SKU-WIDGET-001",
      "quantity": 2
    }
  ],
  "unshippedOrderItemQuantities": [
    {
      "productId": "SKU-GADGET-XL-BLUE",
      "quantity": 1
    }
  ]
}

Sample webhook message for order cancelled event

This sample JSON message demonstrates the example model of the push event for the order cancelled event type sent to your organization's endpoint for your registered webhook.

{
  "eventId": "c9f2e8a1-6b4d-3e7f-a2c5-8f1b4e7a2d5c",
  "eventType": "order_cancelled",
  "tenantId": "7b9c8d6e-5f4a-4321-b0c9-8e7f6a5b4c3d",
  "shipiumOrderId": "ord_2b4a6c8e-1f3d-5b7f-9h1j-3k5m7o9q1s3u",
  "partnerOrderId": "ACME-ORDER-789456",
  "orderStatus": "cancelled",
  "orderEventDateTime": "2025-09-22T16:45:18.234Z",
  "unshippedOrderItemQuantities": [
    {
      "productId": "SKU-WIDGET-001",
      "quantity": 2
    },
    {
      "productId": "SKU-GADGET-XL-BLUE",
      "quantity": 1
    }
  ]
}

Sample webhook message for order completed event

This sample JSON message demonstrates the example model of the push event for the order completed event type sent to your organization's endpoint for your registered webhook.

{
  "eventId": "e7d3f9b5-2a8c-4f1e-9b6d-7c2f5a8e1b4d",
  "eventType": "order_completed",
  "tenantId": "7b9c8d6e-5f4a-4321-b0c9-8e7f6a5b4c3d",
  "shipiumOrderId": "ord_2b4a6c8e-1f3d-5b7f-9h1j-3k5m7o9q1s3u",
  "partnerOrderId": "ACME-ORDER-789456",
  "orderStatus": "completed",
  "orderEventDateTime": "2025-09-24T14:22:07.567Z"
}

Pack App order lifecycle webhook payload elements defined

Data elements for the Pack App order lifecycle event types are defined in the following tables.

Payload elements common to all event types

Payload elements specific to order created and order updated event types

Payload elements specific to order shipped event type

Payload elements specific to order completed event type

Resources

Your Shipium team member is available to help along the way. However, you might find these resources helpful:

• Terms and Definitions

• Troubleshooting Guide

• Contact Shipium Support