Eventjet GraphQL API documentation
Welcome to the documentation for our GraphQL API.
The Endpoint of the API is https://lux.eventjet.at/graphql. If you have any questions, feel free to contact us at support@eventjet.at.
To learn the basics about GraphQL itself, visit the official GraphQL documentation.
Root Fields
Query
| Field | Description | Type |
|---|---|---|
cart | Get a cart by its ID (`Cart.id`). | Cart |
checkEmail | Checks if the given email address is likely to have a typo and resolves to suggestions for the correct email | CheckEmailResult |
checkinTargets | Lists all check-in targets of the source identified by the given scan code. | [ CheckinTarget! ]! |
checkinTargetSource | Resolves the check-in source a scan code identifies, together with its check-in targets. | CheckinTargetSource! |
checkTicketPassword | Checks whether a ticket password exists for an event. | CheckTicketPasswordResult |
company | Get an organizer's account by its ID (`Company.id`). | Company |
discount | Get a single discount by its ID (`Discount.id`). | Discount |
discountGroup | Get a discount group by its ID (`DiscountGroup.id`). | DiscountGroup |
event | Get an event by its ID (`Event.id`). | Event |
eventCategories | Resolves the top-level categories that events can be assigned to. | [ EventCategory! ]! |
events | Lists events hosted by the organizers the authenticated account is connected to. | EventConnection! |
federatedEvents | Lists events that their organizers have published to at least one external platform. | EventConnection! |
form | Get a form by its ID (`Form.id`). | Form |
me | Get the currently authenticated user. | User |
orderStatus | Reads the current status of an order placed with `Mutation.placeOrder`. | OrderStatus |
paymentLink | Get a payment link by its code (`PaymentLink.code`). | PaymentLink |
posPaymentStatusForSale | Reads the current state of the POS payment attached to a sale. | PosPaymentStatusForSalePayload |
predefinedFormElements | Lists the predefined form elements that can be added to a form. | [ FormElement! ]! |
report | Returns a `Report` for a given report type or a previously obtained `Report.id`. | Report |
reportViews | Returns all report views available to the current user, including system defaults and user-saved views. | [ ReportView ] |
seatmap | Get a seatmap by its ID (`Seatmap.id`). | Seatmap |
seatmapScheme | Get a seatmap scheme by its ID (`SeatmapScheme.id`). | SeatmapScheme |
shop | Get a shop by its slug. | Shop |
shops | Resolves shops that currently list at least one event. | [ Shop ] |
ticket | Get a single ticket by its scan code (`Ticket.scanCode`). | Ticket |
tickets | Lists the tickets of all events hosted by the companies you belong to. | TicketConnection! |
Mutation
| Field | Description | Type |
|---|---|---|
addSeatToCart | Adds a seat to a cart. | AddSeatToCartPayload |
addSeatToSale | Adds a specific seat from a seatmap to a sale. Each call adds one seat. | AddSeatToSalePayload |
applyCheckoutOptionsToCart | Applies checkout options like ticket insurance to a cart. | ApplyCheckoutOptionsToCartPayload |
applyCodeToNewCart | Creates a new cart and applies a discount code to it. | ApplyCodeToNewCartPayload |
applyCustomerDataToCart | Applies customer data (email, name, address, etc.) to a cart. | ApplyCustomerDataToCartPayload |
applyCustomerDataToSale | Applies customer data (email, name, address, etc.) to a sale. | ApplyCustomerDataToSalePayload |
applyDiscountCode | Applies a discount code to a cart. | ApplyDiscountCodePayload |
applyTicketHolderDataToCart | Attaches data about the ticket holders to a cart. | ApplyTicketHolderDataToCartPayload |
applyWirecardResponse | Support for this payment integration was removed; this mutation always resolves to `null`. | ApplyWirecardResponsePayload |
attributeCart | Adds attribution data (source, medium, campaign, etc.) to a cart. | AttributeCartPayload |
cancelPaymentLink | Cancels a payment link, preventing it from being used again. | CancelPaymentLinkPayload |
cancelPosPaymentForSale | Cancels a POS card reader payment for a sale. | CancelPosPaymentForSalePayload |
cancelSale | Cancels a sale. | CancelSalePayload |
changeDiscountConstraints | Changes the constraints of a discount. | ChangeDiscountConstraintsPayload |
changeSeatTicketType | Changes the ticket type of a seat that is already in a cart. | ChangeSeatTicketTypePayload |
checkIn | Checks in tickets and reports the outcome of each one separately. | [ CheckinResult! ]! |
completeSale | Completes/finalizes a sale. | CompleteSalePayload |
confirmPaymentLink | Never implemented; this mutation always resolves to `null`. | ConfirmPaymentLinkPayload |
consumeCartFlashMessages | Consumes flash messages that were added to the cart. | [ FlashMessage! ]! |
createDiscount | Creates a single discount code with a code string that you choose yourself. | CreateDiscountPayload |
createForm | Creates a new form. | CreateFormPayload |
createReportView | Saves a report configuration as a new view for the current user. | CreateReportViewPayload |
createReservation | Creates a new `Sale`. | CreateReservationPayload |
createSale | Creates a new box office sale. | CreateSalePayload |
createTag | Creates a new tag. | CreateTagPayload |
createTagAndTagSubject | Creates a tag and attaches it to a subject in one step. | CreateTagAndTagSubjectPayload |
deleteDiscount | Deletes a discount so that its code can no longer be redeemed. | DeleteDiscountPayload |
deleteReportView | Deletes a user-created `ReportView`. | DeleteReportViewPayload |
deleteTag | Deletes a tag. | DeleteTagPayload |
extendCartExpiration | Pushes a cart's expiration time (`Cart.expires`) further into the future. | ExtendCartExpirationResult! |
generateDiscountCodes | Generates a batch of codes with random code strings and bundles them in a new `DiscountGroup`. | GenerateDiscountCodesPayload |
initiatePosPaymentForSale | Initiates a POS card reader payment for a sale. | InitiatePosPaymentForSalePayload |
modifyDiscountGroupConstraints | Replaces the constraints of every discount in a discount group in one call. | ModifyDiscountGroupConstraintsPayload |
modifyForm | Changes the name and the elements of an existing form. | ModifyFormPayload |
modifyReportView | Modifies an existing user-created `ReportView`. | ModifyReportViewPayload |
payPaymentLink | Starts a payment for a payment link so the customer can settle its balance. | PayPaymentLinkPayload |
placeOrder | Turns a cart into an order, optionally creating a payment over the full order total. | PlaceOrderPayload |
removeDiscountCodeFromCart | Removes a previously applied discount code from a cart. | RemoveDiscountCodeFromCartPayload |
removeItemFromCart | Removes an item from a cart by its `CartItem.id`. | RemoveItemFromCartResult! |
removeItemFromSale | Removes an item from a sale. | RemoveItemFromSalePayload |
removeSeatFromCart | Removes a single seat from a cart, addressed by its seatmap and seat ID. | RemoveSeatFromCartPayload |
renameDiscountGroup | Renames a discount group. | RenameDiscountGroupPayload |
setCartItemQuantity | Sets how many tickets of one ticket type a cart contains, creating the cart if needed. | SetCartItemQuantityResult! |
setCartVolumeQuantities | Sets ticket quantities for one general admission area of a seatmap, creating the cart if needed. | SetCartVolumeQuantitiesPayload |
setDiscountStatus | Activates or deactivates a discount. | SetDiscountStatusPayload! |
setSaleItemQuantity | Sets item quantities on a sale by ticket type. Used for ticket types that are not associated with a seatmap. | SetSaleItemQuantityPayload |
setSalePaymentType | Sets the payment type for a sale. | SetSalePaymentTypePayload |
setSaleVolumeQuantities | Sets volume-based ticket quantities on a sale. | SetSaleVolumeQuantitiesPayload |
setShopMarketingCodes | Changes marketing codes for the given shop. This mutation requires authentication. | SetShopMarketingCodesResponse! |
startWirecardPaymentSession | Support for this payment integration was removed; this mutation always resolves to `null`. | StartWirecardPaymentSessionPayload |
tag | Adds a tag to a `TagSubject`. | TagPayload |
untag | Removes a tag from a `TagSubject`. | UntagPayload |