# KorusTicket API KorusTicket API documentation Version: release 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 - [GET /v1/booking/orders/{orderId}/documents](https://docs.korusticket.com/openapi/bookingorderdocument/api_v1bookingorders_orderiddocuments_get_collection.md): Retrieves the collection of BookingOrderDocument resources. - [GET /v1/booking/orders/{orderId}/documents/{id}](https://docs.korusticket.com/openapi/bookingorderdocument/api_v1bookingorders_orderiddocuments_id_get.md): Retrieves a 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 - [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. - [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 - [GET /v1/booking/orders](https://docs.korusticket.com/openapi/bookingorder/api_v1bookingorders_get_collection.md): Retrieves the collection of BookingOrder resources. - [POST /v1/booking/orders/_bulk](https://docs.korusticket.com/openapi/bookingorder/api_v1bookingorders_bulk_post.md): Creates a BookingOrder resource. - [GET /v1/booking/orders/{id}](https://docs.korusticket.com/openapi/bookingorder/api_v1bookingorders_id_get.md): Retrieves a BookingOrder resource. - [POST /v1/booking/orders/{id}/cancel](https://docs.korusticket.com/openapi/bookingorder/api_v1bookingorders_idcancel_post.md): Creates a BookingOrder resource. ## BookingReservation - [GET /v1/booking/reservations](https://docs.korusticket.com/openapi/bookingreservation/api_v1bookingreservations_get_collection.md): List reservations - [POST /v1/booking/reservations/_bulk](https://docs.korusticket.com/openapi/bookingreservation/api_v1bookingreservations_bulk_post.md): 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 se - [GET /v1/booking/reservations/{id}](https://docs.korusticket.com/openapi/bookingreservation/api_v1bookingreservations_id_get.md): Get a reservation - [PATCH /v1/booking/reservations/{id}/release](https://docs.korusticket.com/openapi/bookingreservation/api_v1bookingreservations_idrelease_patch.md): Release a non expired reservation ## TicketingCatalog - [GET /v1/ticketing/catalogs](https://docs.korusticket.com/openapi/ticketingcatalog/api_v1ticketingcatalogs_get_collection.md): ## 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 update - [GET /v1/ticketing/catalogs/{id}](https://docs.korusticket.com/openapi/ticketingcatalog/api_v1ticketingcatalogs_id_get.md): ## 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 ## TicketingOffer - [GET /v1/ticketing/catalogs/{catalogId}/offers](https://docs.korusticket.com/openapi/ticketingoffer/api_v1ticketingcatalogs_catalogidoffers_get_collection.md): ## Attributes details - [GET /v1/ticketing/offers/{id}](https://docs.korusticket.com/openapi/ticketingoffer/api_v1ticketingoffers_id_get.md): Retrieves a TicketingOffer resource. - [GET /v1/ticketing/product_bases/{productBaseId}/offers](https://docs.korusticket.com/openapi/ticketingoffer/api_v1ticketingproduct_bases_productbaseidoffers_get_collection.md): ## Attributes details - [GET /v1/ticketing/catalogs/{catalogId}/offers/{id}](https://docs.korusticket.com/openapi/ticketingoffer/api_v1ticketingcatalogs_catalogidoffers_id_get.md): Retrieves a TicketingOffer resource. ## TicketingOfferAvailability - [GET /v1/ticketing/offers/{id}/availability](https://docs.korusticket.com/openapi/ticketingofferavailability/api_v1ticketingoffers_idavailability_get.md): Retrieves a TicketingOfferAvailability resource. - [GET /v1/ticketing/product_bases/{productBaseId}/availabilities](https://docs.korusticket.com/openapi/ticketingofferavailability/api_v1ticketingproduct_bases_productbaseidavailabilities_get_collection.md): Returns real-time availability for all matching offers under the given product base in a single call. Date range is required and must not exceed 31 days. - [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 - [GET /v1/ticketing/offers/{id}/price](https://docs.korusticket.com/openapi/ticketingofferprice/api_v1ticketingoffers_idprice_get.md): ## 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 - `amou - [GET /v1/ticketing/catalogs/{catalogId}/offers/{id}/price](https://docs.korusticket.com/openapi/ticketingofferprice/api_v1ticketingcatalogs_catalogidoffers_idprice_get.md): ## 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 - `amou ## TicketingOfferTicket - [GET /v1/ticketing/tickets/{id}](https://docs.korusticket.com/openapi/ticketingofferticket/api_v1ticketingtickets_id_get.md): Retrieves a TicketingOfferTicket resource. - [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. - [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. ## TicketingOfferTicketSession - [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 - [GET /v1/ticketing/catalogs/{catalogId}/product_bases/{productBaseId}/options](https://docs.korusticket.com/openapi/ticketingproductbaseoption/api_v1ticketingcatalogs_catalogidproduct_bases_productbaseidoptions_get_collection.md): Retrieves the collection of TicketingProductBaseOption resources. - [GET /v1/ticketing/options/{code}](https://docs.korusticket.com/openapi/ticketingproductbaseoption/api_v1ticketingoptions_code_get.md): Retrieves a TicketingProductBaseOption resource. ## TicketingProductBaseOptionValue - [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 - [GET /v1/ticketing/catalogs/{catalogId}/product_bases](https://docs.korusticket.com/openapi/ticketingproductbase/api_v1ticketingcatalogs_catalogidproduct_bases_get_collection.md): ## Attributes details ### Name Name of the product base. ### Description Description of the product base (HTML string). Localized content. ### ShortDescription Short description of the product base (H - [GET /v1/ticketing/product_bases/{id}](https://docs.korusticket.com/openapi/ticketingproductbase/api_v1ticketingproduct_bases_id_get.md): ## Attributes details ### Name Name of the product base. ### Description Description of the product base (HTML string). Localized content. ### ShortDescription Short description of the product base (H - [GET /v1/ticketing/catalogs/{catalogId}/product_bases/{id}](https://docs.korusticket.com/openapi/ticketingproductbase/api_v1ticketingcatalogs_catalogidproduct_bases_id_get.md): ## Attributes details ### Name Name of the product base. ### Description Description of the product base (HTML string). Localized content. ### ShortDescription Short description of the product base (H ## TicketingProduct - [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. - [GET /v1/ticketing/catalogs/{catalogId}/products](https://docs.korusticket.com/openapi/ticketingproduct/api_v1ticketingcatalogs_catalogidproducts_get_collection.md): Retrieves the collection of TicketingProduct resources. - [GET /v1/ticketing/product_bases/{productBaseId}/products](https://docs.korusticket.com/openapi/ticketingproduct/api_v1ticketingproduct_bases_productbaseidproducts_get_collection.md): Retrieves the collection of TicketingProduct resources. - [GET /v1/ticketing/products/{id}](https://docs.korusticket.com/openapi/ticketingproduct/api_v1ticketingproducts_id_get.md): 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 - [GET /v1/ticketing/seat_maps/{id}](https://docs.korusticket.com/openapi/ticketingseatmap/api_v1ticketingseat_maps_id_get.md): Retrieves a TicketingSeatMap resource. ## TicketingSession - [GET /v1/ticketing/sessions/{id}](https://docs.korusticket.com/openapi/ticketingsession/api_v1ticketingsessions_id_get.md): Retrieves a TicketingSession resource.