Order canceled

EVENT: "EVENTS.CUSTOMER.ORDER.CANCELED"
HTTP method: POST

The EVENTS.CUSTOMER.ORDER.CANCELED event indicates that a customer-related order has been canceled.

When the event is used in an "Order canceled" distribution webhook, the data object always contains the following required objects:

  • customer,
  • referrer,
  • order,
  • redemption.

Additional objects are also sent depending on the purpose:

  • "Notify customers about promotion" sends also the following objects:
    • campaign,
    • promotion_tier,
  • "Send and publish unique codes from campaign" sends also the following objects:
    • campaign,
    • voucher,
    • publication,
  • "Send plain message to customers" sends only the basic objects listed above.

📘

Webhook documentation

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.

Example: customer.order.canceled

{
  "customer": {
    "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "name": "Jack Webhook",
    "email": null,
    "source_id": "jck-wbhk",
    "metadata": {
      "region": "EMEA",
      "sign-up": "true"
    },
    "object": "customer"
  },
  "referrer": null,
  "order": {
    "id": "ord_jM5GdBe4OO3ExFrVSlEWLORP",
    "source_id": null,
    "created_at": "2024-03-12T14:41:49.128Z",
    "updated_at": "2024-03-12T15:06:18.866Z",
    "status": "CANCELED",
    "amount": 2500,
    "total_amount": 2500,
    "items": [
      {
        "object": "order_item",
        "product_id": "prod_0df14b7e7d8975079d",
        "quantity": 1,
        "amount": 2500,
        "price": 2500,
        "subtotal_amount": 2500,
        "product": {
          "name": "Star Thermal Bottle",
          "price": 2500
        }
      },
      {
        "object": "order_item",
        "product_id": "prod_5h1pp1ng",
        "quantity": 1,
        "amount": 0,
        "price": 0,
        "subtotal_amount": 0,
        "product": {
          "name": "Shipping"
        }
      }
    ],
    "metadata": {
      "card": [
        "Other"
      ],
      "region": "US",
      "currency": "USD"
    },
    "customer": {
      "id": "cust_IdgAFZxYwwHctOk9pPuMu308",
      "address": null,
      "summary": null,
      "loyalty": null,
      "referrals": null,
      "object": "customer"
    },
    "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
    "referrer_id": null,
    "object": "order"
  },
  "redemption": null
}
Language
Click Try It! to start a request and see the response here!