# KorusTicket API KorusTicket API documentation Version: 1.0.7 License: None ## Servers Demo server ``` https://api.demo.korusticket.com ``` Production server ``` https://api.korusticket.com ``` ## Security ### JWT Value for the Authorization header parameter. Type: apiKey In: header Name: Authorization ## Download OpenAPI description [KorusTicket API](https://docs.korusticket.com/_spec/openapi.yaml) ## BookingOrderDocument The files associated to the Order. These are typically the customer's tickets for the Event. ### Updates the BookingOrderDocument resource. - [PATCH /v1/booking/orders/{orderId}/documents/{id}](https://docs.korusticket.com/openapi/bookingorderdocument/api_v1bookingorders_orderiddocuments_id_patch.md): Updates the BookingOrderDocument resource. ## BookingOrderItemTicket A ticket is a single ticket for an OrderItem. A ticket is issued by the OrderItem's Order. ### Retrieves a BookingOrderItemTicket resource. - [GET /v1/booking/orders/{orderId}/items/{orderItemId}/tickets/{id}](https://docs.korusticket.com/openapi/bookingorderitemticket/api_v1bookingorders_orderiditems_orderitemidtickets_id_get.md): Retrieves a BookingOrderItemTicket resource. ### Updates the BookingOrderItemTicket resource. - [PATCH /v1/booking/orders/{orderId}/items/{orderItemId}/tickets/{id}](https://docs.korusticket.com/openapi/bookingorderitemticket/api_v1bookingorders_orderiditems_orderitemidtickets_id_patch.md): Updates the BookingOrderItemTicket resource. ## BookingOrder An Order is an actual booking in the ticket issuer's system. ### Retrieves the collection of BookingOrder resources. - [GET /v1/booking/orders](https://docs.korusticket.com/openapi/bookingorder/api_v1bookingorders_get_collection.md): Retrieves the collection of BookingOrder resources. ### Creates a BookingOrder resource. - [POST /v1/booking/orders/_bulk](https://docs.korusticket.com/openapi/bookingorder/api_v1bookingorders_bulk_post.md): Creates a BookingOrder resource. ### Retrieves a BookingOrder resource. - [GET /v1/booking/orders/{id}](https://docs.korusticket.com/openapi/bookingorder/api_v1bookingorders_id_get.md): Retrieves a BookingOrder resource. ## BookingReservation A reservation temporarily holds an Offer, guaranteeing its availability and price for a limited time in the ticket issuer's system. ### Retrieves the collection of BookingReservation resources. - [GET /v1/booking/reservations](https://docs.korusticket.com/openapi/bookingreservation/api_v1bookingreservations_get_collection.md): Retrieves the collection of BookingReservation resources. ### Creates a BookingReservation resource. - [POST /v1/booking/reservations/_bulk](https://docs.korusticket.com/openapi/bookingreservation/api_v1bookingreservations_bulk_post.md): --- Create one or many reservations. --- You can pass multiple offer item to reserve. ### Items Attributes detail #### Offer The offer to reserve. #### Quantity The quantity of offer to reserve. #### TicketSessions Maps each ticket to its selected session. ### Examples of form's fields values - for a field : "M. Doe" - for a field : "true" or "false", - for a field : "3", - for a field : "2.99", - for field : "2025-01-01", - for a field : "07:30", - for a field : "2025-01-01 00:00:00, - for a or field you must pass any of the predefined values. ### Retrieves a BookingReservation resource. - [GET /v1/booking/reservations/{id}](https://docs.korusticket.com/openapi/bookingreservation/api_v1bookingreservations_id_get.md): Retrieves a BookingReservation resource. ## Form A Form can be used to pass custom data to the API. A form is composed of FormField items. ### Show a form - [GET /v1/forms/{id}](https://docs.korusticket.com/openapi/form/api_v1forms_id_get.md): --- Get a form. --- ## Description A form is used to collect additional data. For example, during the order process a form can collects essential customer information for the ticket issuer, including email addresses, allergy notifications, and required accommodations such as baby seats. ## Attributes details ### Code The unique code of this form. ### Fields The fields composing the form. A field can of different types, and can be required or not. ## TicketingCatalog A Catalog is the ticket issuer's collection of products and events. There is usually only one Catalog per TicketIssuer. ### List catalogs - [GET /v1/ticketing/catalogs](https://docs.korusticket.com/openapi/ticketingcatalog/api_v1ticketingcatalogs_get_collection.md): --- Retrieve a collection of catalogs. --- ## Attributes details ### Name Name of the catalog. ### Timestamps * , UTC, the time at which the catalog was first imported. ### Show a catalog - [GET /v1/ticketing/catalogs/{id}](https://docs.korusticket.com/openapi/ticketingcatalog/api_v1ticketingcatalogs_id_get.md): --- Get a single catalog. --- ## Attributes details ### Name Name of the catalog. ### SupportedLanguage Officially supported language for the catalog. This language can be used to query events, products, and other resources in the catalog such as offers. ### Timestamps * , UTC, the time at which the catalog was first imported. ## TicketingEvent Event is an activity that can occur one or multiple times. Every occurrence of this event is a Session. ### Retrieves the collection of TicketingEvent resources. - [GET /v1/ticketing/catalogs/{catalogId}/events](https://docs.korusticket.com/openapi/ticketingevent/api_v1ticketingcatalogs_catalogidevents_get_collection.md): Retrieves the collection of TicketingEvent resources. ### Retrieves a TicketingEvent resource. - [GET /v1/ticketing/catalogs/{catalogId}/events/{id}](https://docs.korusticket.com/openapi/ticketingevent/api_v1ticketingcatalogs_catalogidevents_id_get.md): Retrieves a TicketingEvent resource. ## TicketingOfferAvailability Ticket availability ### Retrieves a TicketingOfferAvailability resource. - [GET /v1/ticketing/catalogs/{catalogId}/offers/{id}/availability](https://docs.korusticket.com/openapi/ticketingofferavailability/api_v1ticketingcatalogs_catalogidoffers_idavailability_get.md): Retrieves a TicketingOfferAvailability resource. ## TicketingOfferPrice Offer Price ### Retrieve the offer's price - [GET /v1/ticketing/catalogs/{catalogId}/offers/{id}/price](https://docs.korusticket.com/openapi/ticketingofferprice/api_v1ticketingcatalogs_catalogidoffers_idprice_get.md): --- Retrieve the offer's price. --- ## Attributes details ### Name Officially supported language for the catalog. This language can be used to query events, products, and other resources in the catalog such as offers. ### Amount - contains the amount including tax - , if provided by the ticket issuer, contains the amount excluding tax ### Currency Only eur is supported for now ## TicketingOfferTicket The tickets contained in an Offer. A tickets give access to an Event's sessions. ### Retrieves the collection of TicketingOfferTicket resources. - [GET /v1/ticketing/catalogs/{catalogId}/offers/{offerId}/tickets](https://docs.korusticket.com/openapi/ticketingofferticket/api_v1ticketingcatalogs_catalogidoffers_offeridtickets_get_collection.md): Retrieves the collection of TicketingOfferTicket resources. ### Retrieves a TicketingOfferTicket resource. - [GET /v1/ticketing/catalogs/{catalogId}/offers/{offerId}/tickets/{id}](https://docs.korusticket.com/openapi/ticketingofferticket/api_v1ticketingcatalogs_catalogidoffers_offeridtickets_id_get.md): Retrieves a TicketingOfferTicket resource. ## TicketingOffer It is the price table of a product. Offers defines the price and availability of a Product at a specific date. ### List offers - [GET /v1/ticketing/catalogs/{catalogId}/offers](https://docs.korusticket.com/openapi/ticketingoffer/api_v1ticketingcatalogs_catalogidoffers_get_collection.md): --- Retrieve a list of offers. --- ## Attributes details ### Retrieves a TicketingOffer resource. - [GET /v1/ticketing/catalogs/{catalogId}/offers/{id}](https://docs.korusticket.com/openapi/ticketingoffer/api_v1ticketingcatalogs_catalogidoffers_id_get.md): Retrieves a TicketingOffer resource. ## TicketingProduct Products are elements that can be purchased to access an Event. The price and availability of a product at specific date and for a specific category are specified in the Offer object. ### Retrieves the collection of TicketingProduct resources. - [GET /v1/ticketing/catalogs/{catalogId}/products](https://docs.korusticket.com/openapi/ticketingproduct/api_v1ticketingcatalogs_catalogidproducts_get_collection.md): Retrieves the collection of TicketingProduct resources. ### Retrieves a TicketingProduct resource. - [GET /v1/ticketing/catalogs/{catalogId}/products/{id}](https://docs.korusticket.com/openapi/ticketingproduct/api_v1ticketingcatalogs_catalogidproducts_id_get.md): Retrieves a TicketingProduct resource. ## TicketingSession Session is an occurrence of an event. ### Retrieves the collection of TicketingSession resources. - [GET /v1/ticketing/catalogs/{catalogId}/events/{eventId}/sessions](https://docs.korusticket.com/openapi/ticketingsession/api_v1ticketingcatalogs_catalogidevents_eventidsessions_get_collection.md): Retrieves the collection of TicketingSession resources. ### Retrieves a TicketingSession resource. - [GET /v1/ticketing/catalogs/{catalogId}/events/{eventId}/sessions/{id}](https://docs.korusticket.com/openapi/ticketingsession/api_v1ticketingcatalogs_catalogidevents_eventidsessions_id_get.md): Retrieves a TicketingSession resource.