Korus Ticket API Specification
/
TicketingOfferTicket

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

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

Retrieves the collection of TicketingOfferTicket resources.

Request

Retrieves the collection of TicketingOfferTicket resources.

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

Catalog identifier

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

Offer identifier

curl -i -X GET \
  'https://api.demo.korusticket.com/v1/ticketing/catalogs/{catalogId}/offers/{offerId}/tickets' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

TicketingOfferTicket collection

Bodyapplication/ld+json
memberArray of objects(TicketingOfferTicket.jsonld-v1.ticket.read)required
member[].​@contextstring or objectread-only
One of:
stringread-only
member[].​@idstringread-only
member[].​@typestringread-only
member[].​idstring
Example: "0194cb3b-55d8-7d9f-a344-cee66d7d20dd"
member[].​namestring
Example: "A great offer's ticket name"
member[].​descriptionstring
Example: "A great offer's ticket description"
member[].​dateAccessboolean
member[].​sessionsArray of objects(TicketingSession.jsonld-v1.ticket.read)
member[].​formstring or null
Example: "/v1/forms/0195197f-7918-7285-bb4b-7df2b682c3eb"
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": [ … ]
  }
}

Retrieves a TicketingOfferTicket resource.

Request

Retrieves a TicketingOfferTicket resource.

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

Catalog identifier

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

Offer identifier

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

Offer Ticket identifier

curl -i -X GET \
  'https://api.demo.korusticket.com/v1/ticketing/catalogs/{catalogId}/offers/{offerId}/tickets/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

TicketingOfferTicket resource

Bodyapplication/ld+json
@contextstring or objectread-only
One of:
stringread-only
@idstringread-only
@typestringread-only
idstring
Example: "0194cb3b-55d8-7d9f-a344-cee66d7d20dd"
namestring
Example: "A great offer's ticket name"
descriptionstring
Example: "A great offer's ticket description"
dateAccessboolean
sessionsArray of objects(TicketingSession.jsonld-v1.ticket.read)
formstring or null
Example: "/v1/forms/0195197f-7918-7285-bb4b-7df2b682c3eb"
Response
application/ld+json
{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "id": "0194cb3b-55d8-7d9f-a344-cee66d7d20dd",
  "name": "A great offer's ticket name",
  "description": "A great offer's ticket description",
  "dateAccess": true,
  "sessions": [
    { … }
  ],
  "form": "/v1/forms/0195197f-7918-7285-bb4b-7df2b682c3eb"
}

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