Skip to content

order.cancelled

An order was cancelled: when BIRP sends this event, what its data holds and an example of its body.

Version v1.2, updated

On this page

BIRP sends order.cancelled to the webhook endpoints that receive it. This page says when it is sent and what data holds, with an example of the body.

When it is sent

The order was cancelled.

Data

data holds an order, with the fields of Orders.

Example

Body of order.cancelledJSON
{
  "api_version": "v1",
  "data": {
    "billing_address": null,
    "confirmed_at": "2026-09-27T08:05:00.000Z",
    "contact": {
      "email": "achats@example.com",
      "name": "Claire Exemple",
      "phone": "+33 0 00 00 00 00"
    },
    "created_at": "2026-09-27T08:00:03.000Z",
    "currency": "EUR",
    "customer_id": "00000000-0000-4000-8000-000000000031",
    "delivered_at": null,
    "document_kind": "order",
    "expected_at": "2026-09-29T06:00:00.000Z",
    "external_ids": [
      {
        "external_id": "order-5512",
        "source": "woocommerce"
      }
    ],
    "id": "00000000-0000-4000-8000-000000000051",
    "lines": [
      {
        "description": null,
        "name": "White bread 500 g",
        "product_id": "00000000-0000-4000-8000-000000000012",
        "product_kind": "finished_product",
        "quantity": "20",
        "sku": "FP-BREAD-500",
        "unit": "pcs",
        "unit_price": "3.2000"
      }
    ],
    "notes": "Deliver before 7:00",
    "number": "EXAMPLE-ORD-0412",
    "ordered_at": "2026-09-27T08:00:00.000Z",
    "shipping_address": {
      "city": "Paris",
      "company": "Epicerie Exemple SARL",
      "country_code": "FR",
      "email": null,
      "line1": "12 rue des Exemples",
      "line2": null,
      "name": "Claire Exemple",
      "phone": "+33 0 00 00 00 00",
      "postal_code": "00000",
      "region": null
    },
    "source": "woocommerce",
    "status": "cancelled",
    "total": "64.00",
    "updated_at": "2026-09-28T14:05:12.417Z"
  },
  "id": "00000000-0000-4000-8000-00000000010e",
  "occurred_at": "2026-09-28T14:05:12.417Z",
  "type": "order.cancelled"
}

Related

  • webhook-events
  • orders
  • verify-webhook-signatures