Skip to main content
This event is triggered when an order cancellation request is created. The event will have a topic of order.cancellationrequest.created.

​
orderId

The unique identifier for the order.

​
poNumber

Purchase order number associated with this order. Defined by the person that placed the order. Is null when not available.

​
status

The current status of the cancellation request. Will be one of:
  • pending - The cancellation request is awaiting review
  • approved - The cancellation request was approved and the order has been cancelled
  • denied - The cancellation request was denied and the order continues processing

​
reason

The reason provided for the cancellation request.

​
createdAt

The timestamp when the cancellation request was created in ISO 8601 format.

​
updatedAt

The timestamp when the cancellation request was last updated in ISO 8601 format.

​
requestedByUserId

The user ID of the person who requested the cancellation.

​
Example payload

{
  "topic": "order.cancellationrequest.created",
  "data": {
    "orderId": "ORD-12345XYZ",
    "poNumber": "customer-po-number",
    "status": "pending",
    "reason": "Customer requested cancellation - wrong item ordered",
    "createdAt": "2025-03-18T15:30:45.123Z",
    "updatedAt": "2025-03-18T15:30:45.123Z",
    "requestedByUserId": "user-abc123"
  }
}