Order Cancelled
BI
CRM
Newsletter
The OrderCancelled event is triggered whenever an existing order is cancelled.
JSON schema & example
Section titled “JSON schema & example”{ "metadata": { "traceId": "19bebc7b-a2f6-4ca7-9b2e-912edc26d6d6", "occurredAt": "2024-12-11T14:42:55Z", "version": "1.0", "tenant": "1337", "type": "CANCELLATION" }, "orderId": "101", "cancellationId": "1", "customerId": "rxrn:cx:14450:customer:jg8o46vllzzupz4qpd7plve3", "refundAmount": -2.96, "includedVatAmount": -72.91, "currency": "EUR", "refundType": "BILL", "cancelDateTime": "2022-05-24T07:15:29Z", "fullCancellation": true, "cancelledTickets": [ "POS098350024", "POS098350026", "POS098350027" ], "cancelledSeasonTickets": [ "POS098350036", "POS098350037" ], "cancelledArticles": [ "POS098350031" ], "cancelledSubscriptions": [], "cancelledPackages": [ "POS098350025" ], "cancelledSubscriptionPackages": [], "custom": {}}{ "type": "object", "$schema": "http://json-schema.org/draft-07/schema#", "properties": { "metadata": { "type": "object", "properties": { "traceId": { "type": "string", "format": "uuid", "description": "Unique identifier to trace the event." }, "occurredAt": { "type": "string", "format": "date-time", "description": "The timestamp when the event occurred." }, "version": { "type": "string", "pattern": "^[0-9]+\\.[0-9]+$", "description": "The version of the event schema, following semantic versioning." }, "tenant": { "type": "string", "description": "Identifier of the tenant or organization associated with the event." }, "type": { "type": "string", "enum": [ "CUSTOMER", "CUSTOMER_DELETED", "EVENT", "EVENT_CAPACITY", "ORDER", "CANCELLATION", "CREDIT_NOTE", "RESERVATION", "RESERVATION_CANCELLATION", "PRICE_PROFILE", "PRICE_PROFILE_DELETED", "TICKET" ], "description": "Identifier of the tenant or organization associated with the event." } }, "required": [ "traceId", "occurredAt", "version", "tenant", "type" ], "additionalProperties": false }, "orderId": { "type": "string" }, "cancellationId": { "type": "string" }, "customerId": { "type": "string" }, "refundAmount": { "type": "number" }, "includedVatAmount": { "type": "number" }, "currency": { "type": "string" }, "refundType": { "type": "string", "enum": [ "CASH", "EC", "VISA", "MASTERCARD", "POSTCARD", "CHECK", "AMEX", "AMEX_VOUCHER", "DINERS_CLUB", "HOUSE_BILL", "BANK_TRANSFER", "DIRECT_DEBIT", "CREDIT_CARD", "BILL", "PAYPAL", "SOFORTUEBERWEISUNG", "KLARNA", "NONE", "UNKNOWN" ] }, "cancelDateTime": { "type": "string", "format": "date-time", "description": "\"ISO 8601 formatted date and time of the cancellation.", "examples": [ "2024-03-01T19:30:00Z" ] }, "fullCancellation": { "type": "boolean" }, "cancelledTickets": { "type": "array", "items": { "type": "string", "description": "Position identifier for the ticket.", "examples": [ "pos_001" ] } }, "cancelledSeasonTickets": { "type": "array", "items": { "type": "string", "description": "Position identifier for the ticket.", "examples": [ "pos_001" ] } }, "cancelledArticles": { "type": "array", "items": { "type": "string", "description": "Position identifier for the ticket.", "examples": [ "pos_001" ] } }, "cancelledSubscriptions": { "type": "array", "items": { "type": "string", "description": "Position identifier for the ticket.", "examples": [ "pos_001" ] } }, "cancelledPackages": { "type": "array", "items": { "type": "string", "description": "Position identifier for the ticket.", "examples": [ "pos_001" ] } }, "cancelledSubscriptionPackages": { "type": "array", "items": { "type": "string", "description": "Position identifier for the ticket.", "examples": [ "pos_001" ] } }, "cancelledFees": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "description": "The monetary value of the fee.", "examples": [ "0.25" ] }, "feeType": { "type": "string", "enum": [ "SHIPPING", "RESALE", "ADDITIONAL", "CANCELLATION", "SALE", "UNKNOWN" ], "description": "The type of fee being applied.", "examples": [ "RESALE" ] }, "detailType": { "type": "string", "enum": [ "ARTICLE_COMMISSION", "NET_PRICE", "ADVANCE_BOOKING_FEE", "SYSTEM_FEE", "DELIVERY_FEE", "ADDITIONAL_FEES", "FEE_1", "FEE_2", "FEE_3", "FEE_4", "FEE_5", "FEE_6", "REFUND_FEE", "RESALE_FEE", "RESALE_PURCHASE_FEE", "CANCELLATION_FEE", "DISCOUNT", "CREDIT", "CREDIT_VOUCHER", "COUPON_RESIDUAL_DISCHARGE", "UNKNOWN" ], "description": "The component type associated with the fee.", "examples": [ "ADVANCE_BOOKING_FEE" ] } }, "required": [ ] }, "description": "An array of cancelled fees, each with an amount, type, and price component type." }, "cancellationFees": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "description": "The monetary value of the fee.", "examples": [ "0.25" ] }, "feeType": { "type": "string", "enum": [ "SHIPPING", "RESALE", "ADDITIONAL", "CANCELLATION", "SALE", "UNKNOWN" ], "description": "The type of fee being applied.", "examples": [ "RESALE" ] }, "detailType": { "type": "string", "enum": [ "ARTICLE_COMMISSION", "NET_PRICE", "ADVANCE_BOOKING_FEE", "SYSTEM_FEE", "DELIVERY_FEE", "ADDITIONAL_FEES", "FEE_1", "FEE_2", "FEE_3", "FEE_4", "FEE_5", "FEE_6", "REFUND_FEE", "RESALE_FEE", "RESALE_PURCHASE_FEE", "CANCELLATION_FEE", "DISCOUNT", "CREDIT", "CREDIT_VOUCHER", "COUPON_RESIDUAL_DISCHARGE", "UNKNOWN" ], "description": "The component type associated with the fee.", "examples": [ "ADVANCE_BOOKING_FEE" ] } }, "required": [ ] }, "description": "An array of cancellation fees, each with an amount, type, and price component type." }, "custom": { "type": "object", "description": "Custom data object" } }, "required": [ "orderId", "cancellationId", "metadata" ], "additionalProperties": false}