Shipping Events

A comprehensive list of events that can activate webhooks for shipping methods, including creation, updates, and removals.

Events

Event	Description
`shipping-created`	Triggers whenever a new shipping is created.
`shipping-updated`	Triggers whenever a shipping is updated.
`shipping-removed`	Triggers whenever a shipping is deleted.

Webhook Payload Examples

shipping-created

{
  "event_id": "whev_kv28w431nh7rw9d2r",
  "event_type": "shipping-created",
  "api_version": 2,
  "object": "event",
  "endpoint_id": "5dcbcd22-c0e5-4003-8223-e367ce5eb8bf",
  "data": {
    "shipping": {
      "id": "c8006b68-6619-4b3f-844c-7025ffaa5b3b",
      "label": "New Shipping Method",
      "currency": "EUR",
      "destination": [
        "worldwide"
      ],
      "price": 12,
      "has_bundling": true,
      "postcodes": [],
      "states": [],
      "sites": [],
      "object": "shipping",
      "active": true,
      "bundling_rules": [
        {
          "cost_rule": "unit",
          "type": "range",
          "max": 100,
          "cost": 100,
          "from": 1,
          "to": 5
        },
        {
          "cost_rule": "fixed",
          "type": "max",
          "max": 5,
          "cost": 80
        }
      ]
    }
  }
}

shipping-updated

{
  "event_id": "whev_kv28w431nh7rw9d2r",
  "event_type": "shipping-updated",
  "api_version": 2,
  "object": "event",
  "endpoint_id": "5dcbcd22-c0e5-4003-8223-e367ce5eb8bf",
  "data": {
    "changes": [
      "label"
    ],
    "shipping": {
      "id": "c8006b68-6619-4b3f-844c-7025ffaa5b3b",
      "label": "New Shipping Method",
      "currency": "EUR",
      "destination": [
        "worldwide"
      ],
      "price": 12,
      "has_bundling": true,
      "postcodes": [],
      "states": [],
      "sites": [],
      "object": "shipping",
      "active": true,
      "bundling_rules": [
        {
          "cost_rule": "unit",
          "type": "range",
          "max": 100,
          "cost": 100,
          "from": 1,
          "to": 5
        },
        {
          "cost_rule": "fixed",
          "type": "max",
          "max": 5,
          "cost": 80
        }
      ]
    }
  }
}

shipping-removed

{
  "event_id": "whev_kv28w431nh7rw9d2r",
  "event_type": "shipping-removed",
  "api_version": 2,
  "object": "event",
  "endpoint_id": "5dcbcd22-c0e5-4003-8223-e367ce5eb8bf",
  "data": {
    "shipping": { "id": "c8006b68-6619-4b3f-844c-7025ffaa5b3b" }
   }
}