# KorusTicket API KorusTicket API documentation Version: 1.0.38 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/_bundle/openapi.yaml) ## BookingOrderDocument The files associated to the Order. These are typically the customer's tickets for the Event. ### Retrieves the collection of BookingOrderDocument resources. - [GET /v1/booking/orders/{orderId}/documents](https://docs.korusticket.com/openapi/bookingorderdocument/api_v1bookingorders_orderiddocuments_get_collection.md): Retrieves the collection of BookingOrderDocument resources. ### Retrieves a BookingOrderDocument resource. - [GET /v1/booking/orders/{orderId}/documents/{id}](https://docs.korusticket.com/openapi/bookingorderdocument/api_v1bookingorders_orderiddocuments_id_get.md): Retrieves a BookingOrderDocument resource. ### 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 text field : "M. Doe" - for a bool field : "true" or "false", - for a integer field : "3", - for a decimal field : "2.99", - for date field : "2025-01-01", - for a time field : "07:30", - for a datetime field : "2025-01-01 00:00:00, - for a single_choice or multi_choice 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. ## 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 * createdAt, UTC, the time at which the catalog was first imported. * lastSyncedAt, UTC, the time at which the catalog was updated. ### ShortDescription Short description of the catalog (HTML string). May be null. Localized content. ### Description Description of the catalog (HTML string). May be null. Localized content. ### TermsOfUse Terms of use of the catalog (HTML string). May be null. Localized content. ### Venue Venue information for the catalog. May be null. * name: Venue name * line1, line2: Address lines * postalCode, city, country: Address details * phone, website: Contact information * latitude, longitude: Geographic coordinates (decimal degrees, returned as strings) ### Medias content * logo: Logo image if available * gallery: Gallery images ordered by position ### 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 * created_at, UTC, the time at which the catalog was first imported. * lastSyncedAt, UTC, the time at which the catalog was updated. ### ShortDescription Short description of the catalog (HTML string). May be null. Localized content. ### Description Description of the catalog (HTML string). May be null. Localized content. ### TermsOfUse Terms of use of the catalog (HTML string). May be null. Localized content. ### Venue Venue information for the catalog. May be null. * name: Venue name * line1, line2: Address lines * postalCode, city, country: Address details * phone, website: Contact information * latitude, longitude: Geographic coordinates (decimal degrees, returned as strings) ### Medias content * logo: Logo image if available * gallery: Gallery images ordered by position ## 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. ## 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 - amountInclTax contains the amount including 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 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. ### Retrieves the collection of TicketingOfferTicket resources. (deprecated) - [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. ## TicketingOfferTicketSession OfferTicketSession represents the time slot of an OfferTicket. ### Retrieves a TicketingOfferTicketSession resource. - [GET /v1/ticketing/catalogs/{catalogId}/offers/{offerId}/tickets/{ticketId}/sessions/{id}](https://docs.korusticket.com/openapi/ticketingofferticketsession/api_v1ticketingcatalogs_catalogidoffers_offeridtickets_ticketidsessions_id_get.md): Retrieves a TicketingOfferTicketSession resource. ## TicketingProductBaseOption Product Base available option ### Retrieves the collection of TicketingProductBaseOption resources. - [GET /v1/ticketing/catalogs/{catalogId}/product_bases/{id}/options](https://docs.korusticket.com/openapi/ticketingproductbaseoption/api_v1ticketingcatalogs_catalogidproduct_bases_idoptions_get_collection.md): Retrieves the collection of TicketingProductBaseOption resources. ### Retrieves a TicketingProductBaseOption resource. - [GET /v1/ticketing/catalogs/{catalogId}/product_bases/{productBaseId}/options/{code}](https://docs.korusticket.com/openapi/ticketingproductbaseoption/api_v1ticketingcatalogs_catalogidproduct_bases_productbaseidoptions_code_get.md): Retrieves a TicketingProductBaseOption resource. ## TicketingProductBaseOptionValue Product Base available option values ### Retrieves the collection of TicketingProductBaseOptionValue resources. - [GET /v1/ticketing/catalogs/{catalogId}/product_bases/{productBaseId}/options/{code}/values](https://docs.korusticket.com/openapi/ticketingproductbaseoptionvalue/api_v1ticketingcatalogs_catalogidproduct_bases_productbaseidoptions_codevalues_get_collection.md): Retrieves the collection of TicketingProductBaseOptionValue resources. ## TicketingProductBase Product Base are the main elements of a catalog. They allow to group related products. They contain option with values that can be used to filter products. ### Retrieves the collection of TicketingProductBase resources. - [GET /v1/ticketing/catalogs/{catalogId}/product_bases](https://docs.korusticket.com/openapi/ticketingproductbase/api_v1ticketingcatalogs_catalogidproduct_bases_get_collection.md): Retrieves the collection of TicketingProductBase resources. ### Retrieves a TicketingProductBase resource. - [GET /v1/ticketing/catalogs/{catalogId}/product_bases/{id}](https://docs.korusticket.com/openapi/ticketingproductbase/api_v1ticketingcatalogs_catalogidproduct_bases_id_get.md): Retrieves a TicketingProductBase resource. ## TicketingProduct Products are elements that can be purchased. 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}/product_bases/{productBaseId}/products](https://docs.korusticket.com/openapi/ticketingproduct/api_v1ticketingcatalogs_catalogidproduct_bases_productbaseidproducts_get_collection.md): Retrieves the collection of TicketingProduct resources. ### 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. ## TicketingSeatMap The SeatMap contains the layout of the seats for a chosen session. ### Retrieves a TicketingSeatMap resource. - [GET /v1/ticketing/catalogs/{catalogId}/product_bases/{productBaseId}/seat_maps/{id}](https://docs.korusticket.com/openapi/ticketingseatmap/api_v1ticketingcatalogs_catalogidproduct_bases_productbaseidseat_maps_id_get.md): Retrieves a TicketingSeatMap resource.