Korus Ticket API Specification
/
BookingReservation

KorusTicket API (dev)

KorusTicket API documentation

Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL https://www.korusticket.com/
KorusTicket [email protected]
License None
Languages
Servers
Demo server
https://api.demo.korusticket.com/
Production server
https://api.korusticket.com/

BookingOrderDocument

The files associated to the Order. These are typically the customer's tickets for the Event.

Operations

BookingOrder

An Order is an actual booking in the ticket issuer's system.

Operations

BookingReservation

A reservation temporarily holds an Offer, guaranteeing its availability and price for a limited time in the ticket issuer's system.

Operations

Retrieves the collection of BookingReservation resources.

Request

Retrieves the collection of BookingReservation resources.

Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 50 ]

The number of items per page

Default 10
order[createdAt]string

Order by createdAt

Enum"asc""desc"
curl -i -X GET \
  'https://api.demo.korusticket.com/v1/booking/reservations?itemsPerPage=10&order%5BcreatedAt%5D=asc&page=1' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

BookingReservation collection

Bodyapplication/ld+json
memberArray of objects(BookingReservation.jsonld-v1.reservation.read)required
member[].​@idstringread-only
member[].​@typestringread-only
member[].​@contextstring or objectread-only
One of:
stringread-only
member[].​expiredbooleanread-only
member[].​idstring
Example: "0194cb34-0ad0-711e-b447-6e7a9423e96c"
member[].​createdAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
member[].​totalAmountInclTaxstring
Example: "100.00"
member[].​totalAmountExclTaxstring or null
Example: "80.00"
member[].​expiresAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
member[].​itemsArray of objects(ReservationItem.jsonld-v1.reservation.read)
member[].​organizationstring
Example: "/v1/organizations/0194cb23-170e-71f0-b4bb-0a7e644dea34"
member[].​orderstring or null
totalItemsinteger>= 0
viewobject
Example: {"@id":"string","type":"string","first":"string","last":"string","previous":"string","next":"string"}
searchobject
Response
application/ld+json
{
  "member": [
    { … }
  ],
  "totalItems": 0,
  "view": {
    "@id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "search": {
    "@type": "string",
    "template": "string",
    "variableRepresentation": "string",
    "mapping": [ … ]
  }
}

Creates a BookingReservation resource.

Request

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.
Bodyapplication/ld+jsonrequired

The new BookingReservation resource

itemsArray of objects(OfferReservationInput.jsonld-v1.reservation.create_bulk_write)non-empty
curl -i -X POST \
  https://api.demo.korusticket.com/v1/booking/reservations/_bulk \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/ld+json' \
  -d '{
    "items": [
      {
        "offer": "https://example.com/",
        "quantity": 1,
        "ticketSessions": [
          {
            "ticket": "https://example.com/",
            "session": "https://example.com/",
            "formData": {
              "form": "/v1/forms/0195197f-7918-7285-bb4b-7df2b682c3eb",
              "fields": [
                {
                  "field": "/v1/forms/01953871-e6dd-7f75-8c2d-39a2dd122b22/fields/01953871-e6df-7135-bd6c-ebe655262810",
                  "value": "Doe"
                }
              ]
            }
          }
        ]
      }
    ]
  }'

Responses

BookingReservation resource created

Bodyapplication/ld+json
@contextstring or objectread-only
One of:
stringread-only
@idstringread-only
@typestringread-only
reservationsArray of objects(BookingReservation.jsonld-v1.reservation.create_bulk_read)
failedReservationsArray of objects(FailedReservation.jsonld-v1.reservation.create_bulk_read)
Response
application/ld+json
{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "reservations": [
    { … }
  ],
  "failedReservations": [
    { … }
  ]
}

Retrieves a BookingReservation resource.

Request

Retrieves a BookingReservation resource.

Path
idstring[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0...required

Reservation identifier

curl -i -X GET \
  'https://api.demo.korusticket.com/v1/booking/reservations/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

BookingReservation resource

Bodyapplication/ld+json
@idstringread-only
@typestringread-only
@contextstring or objectread-only
One of:
stringread-only
expiredbooleanread-only
idstring
Example: "0194cb34-0ad0-711e-b447-6e7a9423e96c"
createdAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
totalAmountInclTaxstring
Example: "100.00"
totalAmountExclTaxstring or null
Example: "80.00"
expiresAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
itemsArray of objects(ReservationItem.jsonld-v1.reservation.read)
organizationstring
Example: "/v1/organizations/0194cb23-170e-71f0-b4bb-0a7e644dea34"
orderstring or null
Response
application/ld+json
{
  "@id": "string",
  "@type": "string",
  "@context": "string",
  "expired": true,
  "id": "0194cb34-0ad0-711e-b447-6e7a9423e96c",
  "createdAt": "2025-01-27T15:15:20+00:00",
  "totalAmountInclTax": "100.00",
  "totalAmountExclTax": "80.00",
  "expiresAt": "2025-01-27T15:15:20+00:00",
  "items": [
    { … }
  ],
  "organization": "/v1/organizations/0194cb23-170e-71f0-b4bb-0a7e644dea34",
  "order": "string"
}

FormFieldChoice

Form field choice is a predefined option that users can select from a list of available values in a form field.

FormField

Form fields compose a form. A field has a type and can be required or not. When submitting a form, all required fields must be completed with valid values.

Form

A Form can be used to pass custom data to the API. A form is composed of FormField items.

Operations

TicketingCatalog

A Catalog is the ticket issuer's collection of products and events. There is usually only one Catalog per TicketIssuer.

Operations

TicketingEvent

Event is an activity that can occur one or multiple times. Every occurrence of this event is a Session.

Operations

TicketingOfferAvailability

Ticket availability

Operations

TicketingOfferPrice

Offer Price

Operations

TicketingOfferTicket

The tickets contained in an Offer. A tickets give access to an Event's sessions.

Operations

TicketingOffer

It is the price table of a product. Offers defines the price and availability of a Product at a specific date.

Operations

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.

Operations

TicketingSessionAvailability

Session availability

Operations

TicketingSession

Session is an occurrence of an event.

Operations