Order Cancelled (v0.0.1)

Indicates an order has been canceled

Event

Overview

Occurs when an order is canceled for any number of reasons, including human error or customer cancellation. Cancellation can happen to any type of order. An order cancellation event always carries with it the list of items that were in that order at the time of cancellation.

Architecture Diagram

publishes event
Orders
v0.0.1Service
Order Cancelled
v0.0.1Event
Key
  • Event
  • Service
  • Command
React Flow
Open in Visualiser →

Example Payload

Example payload
{
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "cancellationReason": "Customer requested cancellation",
  "orderItems": [
    {
      "itemId": "123e4567-e89b-12d3-a456-426614174000",
      "sku": "abc1234",
      "quantity": 5
    }
  ]
  "timestamp": "2024-07-04T14:48:00Z"
}

Schema (JSON)

orderId
string<uuid>
required

The unique identifier of the order that was cancelled.

orderItems
array[object]

A list of the line items on the order at the time of cancellation.

itemId
string<uuid>
required

The unique identifier of the line item.

sku
string

The SKU for this item

quantity
integer

The quantity of the item ordered.

cancellationReason
string

The reason for the order cancellation, if provided.

timestamp
string<date-time>
required

The date and time when the order was cancelled.