Skip to main content
POST
/
EVENTS.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
}

Response

200 - application/json

Indicates that the order has been canceled.

Event data object schema for customer.order.canceled.

​
customer
object
required

Simplified customer data.

​
referrer
object
required

Simplified customer data.

​
order
object
required

Order information.

​
redemption
object
required

Redemption data used for internal communication

​
campaign
object

Details about the campaign related to the distribution with a promotion or send voucher purpose.

​
voucher
object

Details about the voucher related to the distribution with a send voucher purpose.

​
publication
object

Details about the publication related to the distribution with a send voucher purpose.

​
promotion_tier
object

Details about the promotion tier related to the distribution with a promotion purpose.

⌘I