Order Created
BI
CRM
Newsletter
The Order event is triggered when an order has been successfully placed.
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": "ORDER" }, "orderId": "87654321", "customerId": "rxrn:cx:14450:customer:624291d6e0591da94e503788", "currency": "EUR", "price": 69.45, "includedVatAmount": 11.09, "paymentType": "PAYPAL", "orderDateTime": "2019-11-06T13:37:13Z", "shippingType": "PRINT_AT_HOME", "pointOfSale": "WEB_SHOP", "invoiceAddress": { "country": "DE", "zipCode": "79116", "city": "Freiburg" }, "singleTickets": [ { "positionId": "1", "eventId": "34984127", "seat": { "block": "Loge", "blockId": "196848", "row": "3", "seat": "142", "areaId": "987654" }, "price": 47.22, "pricing": { "level": "Normalpreis", "levelNumber": "1", "category": "1. Kategorie", "categoryNumber": "1" }, "priceComponents": [ { "type": "ADVANCE_BOOKING_FEE", "amount": 2.5 }, { "type": "SYSTEM_FEE", "amount": 1.2 }, { "type": "NET_PRICE", "amount": 21.1 } ] } ], "seasonTickets": [ { "positionId": "POS124800101", "eventId": "1403958", "seat": { "block": "Parkett rechts", "blockId": "42", "row": "3", "seat": "142", "categoryId": "1" }, "price": 170.00, "pricing": { "level": "Normalpreis Dauerkarte", "levelNumber": "2", "category": "1. Kategorie", "categoryNumber": "1" }, "priceComponents": [ { "type": "ADVANCE_BOOKING_FEE", "amount": 2.5 }, { "type": "SYSTEM_FEE", "amount": 1.2 }, { "type": "NET_PRICE", "amount": 21.1 } ] } ], "subscriptions": [ { "positionId": "4711", "price": 331, "tickets": [ { "positionId": "1", "eventId": "34984127", "seat": { "block": "Loge", "blockId": "196848", "row": "3", "seat": "142", "categoryId": "3" }, "price": 47.22, "pricing": { "level": "Normalpreis", "levelNumber": "1", "category": "1. Kategorie", "categoryNumber": "1" }, "priceComponents": [ { "type": "ADVANCE_BOOKING_FEE", "amount": 2.5 }, { "type": "SYSTEM_FEE", "amount": 1.2 }, { "type": "NET_PRICE", "amount": 21.1 } ] } ] } ], "packages": [ { "positionId": "1", "ticket": { "positionId": "1", "eventId": "34984127", "seat": { "block": "Loge", "blockId": "196848", "row": "3", "seat": "142", "categoryId": "3", "areaId": "987654" }, "price": 47.22, "pricing": { "level": "Normalpreis", "levelNumber": "1", "category": "1. Kategorie", "categoryNumber": "1" }, "priceComponents": [ { "type": "ADVANCE_BOOKING_FEE", "amount": 2.5 }, { "type": "SYSTEM_FEE", "amount": 1.2 }, { "type": "NET_PRICE", "amount": 21.1 } ] }, "price": 123, "articles": [ { "articleId": "4122", "positionId": "1", "price": 241.2 } ] } ], "subscriptionsPackages": [ { "positionId": "1", "subscription": { "positionId": "4711", "price": 331, "tickets": [ { "positionId": "1", "eventId": "34984127", "seat": { "block": "Loge", "blockId": "196848", "row": "3", "seat": "142", "categoryId": "3", "areaId": "1337" }, "price": 47.22, "pricing": { "level": "Normalpreis", "levelNumber": "1", "category": "1. Kategorie", "categoryNumber": "1" }, "priceComponents": [ { "type": "ADVANCE_BOOKING_FEE", "amount": 2.5 }, { "type": "SYSTEM_FEE", "amount": 1.2 }, { "type": "NET_PRICE", "amount": 21.1 } ] } ] }, "price": 123, "articles": [ { "articleId": "4122", "positionId": "1", "price": 241.2 } ] } ], "articles": [ { "articleId": "4122", "positionId": "1", "price": 241.2 } ], "fees": [ { "amount": 3.9, "type": "SHIPPING", "detailType": "DELIVERY_FEE" }, { "amount": 33.33, "type": "RESALE", "detailType": "RESALE_FEE" } ], "custom": {}}{ "$schema": "https://json-schema.org/draft/2020-12/schema", "title": "Order", "type": "object", "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", "description": "Unique identifier for the order.", "examples": [ 123456 ] }, "customerId": { "type": "string", "description": "Identifier for the customer placing the order.", "examples": [ "rxrn:cx:1337:customer:624291d6e0591da94e503788" ] }, "currency": { "type": "string", "description": "ISO currency code used for the transaction.", "pattern": "^[A-Z]{3}$", "examples": [ "CHF", "EUR" ] }, "price": { "type": "number", "description": "Total price for the order.", "examples": [ 99.99 ] }, "includedVatAmount": { "type": "number", "description": "VAT amount included in the total price.", "examples": [ 19.99 ] }, "paymentType": { "type": "string", "description": "Payment method used for the order.", "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" ], "examples": [ "CREDIT_CARD" ] }, "orderDateTime": { "type": "string", "description": "ISO 8601 formatted date and time of the order.", "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}Z$", "examples": [ "2023-07-15T14:30:00Z" ] }, "shippingType": { "type": "string", "description": "Shipping Type used for the order.", "enum": [ "UNKNOWN", "PICKUP", "MAIL", "PRINT_AT_HOME", "PRINT_AT_HOME_AFTER_PAYMENT", "DHL_DOMESTIC", "DHL_INTERNATIONAL", "EXPRESS", "WALLET", "APP_TICKET" ], "examples": [ "PRINT_AT_HOME" ] }, "pointOfSale": { "type": "string", "description": "Point of Sale used for the order.", "enum": [ "WEB_SHOP", "RESERVIX", "INTERNAL_TICKET_OFFICE", "EXTERNAL_TICKET_OFFICE", "UNKNOWN" ], "examples": [ "RESERVIX", "WEB_SHOP" ] }, "invoiceAddress": { "type": "object", "properties": { "country": { "type": "string", "description": "Country code of the invoice address of the buyer/customer." }, "zipCode": { "type": "string", "description": "Postal or ZIP code of the invoice address." }, "city": { "type": "string", "description": "City of the invoice address." } } }, "singleTickets": { "type": "array", "description": "Array of tickets included in the order.", "items": { "$ref": "#/definitions/Ticket" } }, "seasonTickets": { "type": "array", "description": "Array of season tickets included in the order.", "items": { "$ref": "#/definitions/Ticket" } }, "subscriptions": { "type": "array", "description": "Array of subscriptions included in the order.", "items": { "$ref": "#/definitions/Subscription" } }, "packages": { "type": "array", "description": "Array of packages included in the order.", "items": { "$ref": "#/definitions/Package" } }, "subscriptionsPackages": { "type": "array", "description": "Array of subscription packages included in the order.", "items": { "$ref": "#/definitions/SubscriptionPackage" } }, "articles": { "type": "array", "description": "Array of articles included in the order.", "items": { "$ref": "#/definitions/Article" } }, "fees": { "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 fees, each with an amount, type, and price component type." }, "custom": { "type": "object", "description": "Custom data object" } }, "definitions": { "Ticket": { "type": "object", "properties": { "positionId": { "type": "string", "description": "Identifier of the position within the order.", "examples": [ "POS124800101" ] }, "eventId": { "type": "string", "description": "Unique identifier for the event.", "examples": [ "987654" ] }, "seat": { "type": "object", "description": "Seating details for the ticket.", "properties": { "blockId": { "type": "string", "description": "Block id", "examples": [ "1337" ] }, "block": { "type": "string", "description": "Block name within the venue.", "examples": [ "Block A" ] }, "row": { "type": "string", "description": "Row identifier within the block.", "examples": [ "5" ] }, "seat": { "type": "string", "description": "Seat identifier within the row.", "examples": [ "42" ] }, "areaId": { "type": "string", "description": "Area identifier.", "examples": [ "98765" ] } } }, "price": { "type": "number", "description": "Price of the ticket.", "examples": [ 49.99 ] }, "pricing": { "type": "object", "description": "Details about pricing structure.", "properties": { "level": { "type": "string", "description": "Price level of the ticket.", "examples": [ "Normalpreis" ] }, "levelNumber": { "type": "string", "description": "Number/index of the price profile level", "examples": [ "1", "2" ] }, "category": { "type": "string", "description": "Price category of the ticket.", "examples": [ "1. Kategorie" ] }, "categoryNumber": { "type": "string", "description": "Number/Index of the category within the price profile.", "examples": [ "1", "5" ] } } }, "priceComponents": { "type": "array", "items": { "type": "object", "properties": { "priceComponentType": { "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 type of the price component.", "examples": [ "ADVANCE_BOOKING_FEE", "NET_PRICE" ] }, "amount": { "type": "number", "description": "The monetary value of the price component.", "examples": [ 0.69 ] } }, "required": [ ] }, "description": "An array of price components, each with a type and amount." } }, "required": [] }, "Article": { "type": "object", "properties": { "articleId": { "type": "string", "description": "Identifier of the position within the order.", "examples": [ "5641587" ] }, "positionId": { "type": "string", "description": "Position identifier within the order for the article.", "examples": [ "POS171942728" ] }, "price": { "type": "number", "description": "Price of the article.", "examples": [ 24.99 ] }, "name": { "type": "string", "description": "Name of the article.", "examples": [ "Fan T-Shirt", "Tasse" ] } }, "required": [] }, "Subscription": { "type": "object", "properties": { "positionId": { "type": "string", "description": "Identifier of the position within the order.", "examples": [ "POS171942728" ] }, "eventId": { "type": "string", "description": "Unique identifier for the event.", "examples": [ "6595" ] }, "price": { "type": "number", "description": "Price of the article.", "examples": [ 24.99 ] }, "tickets": { "type": "array", "description": "Array of ticket positions included in the order.", "items": { "$ref": "#/definitions/Ticket" } } }, "required": [] }, "Package": { "type": "object", "properties": { "positionId": { "type": "string", "description": "Identifier of the position within the order.", "examples": [ "POS171942728" ] }, "ticket": { "type": "object", "description": "Array of ticket positions included in the order.", "$ref": "#/definitions/Ticket" }, "price": { "type": "number", "description": "Price of the article.", "examples": [ 24.99 ] }, "articles": { "type": "array", "description": "Array of ticket positions included in the order.", "items": { "$ref": "#/definitions/Article" } } }, "required": [] }, "SubscriptionPackage": { "type": "object", "properties": { "positionId": { "type": "string", "description": "Identifier of the position within the order.", "examples": [ "POS171942728" ] }, "subscription": { "type": "object", "description": "Array of ticket positions included in the order.", "subscription": { "$ref": "#/definitions/Subscription" } }, "price": { "type": "number", "description": "Price of the article.", "examples": [ 24.99 ] }, "articles": { "type": "array", "description": "Array of ticket positions included in the order.", "items": { "$ref": "#/definitions/Article" } } }, "required": [] } }, "required": [ "orderId", "metadata" ], "additionalProperties": false}