Korus Ticket API Specification
/
TicketingOffer
/
List offers

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

TicketingOffer

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

Operations

List offers

Request

Attributes details

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

Catalog identifier

Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 50 ]

The number of items per page

Default 10
order[date]string

Order by date

Enum"asc""desc"
date[after]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...
date[strictly_after]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...
date[before]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...
date[strictly_before]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...
product[]Array of strings

Filter by product

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

Filter by session

curl -i -X GET \
  'https://api.demo.korusticket.com/v1/ticketing/catalogs/{catalogId}/offers?date%5Bafter%5D=string&date%5Bbefore%5D=string&date%5Bstrictly_after%5D=string&date%5Bstrictly_before%5D=string&itemsPerPage=10&order%5Bdate%5D=asc&page=1&product%5B%5D=string&session=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

TicketingOffer collection

Bodyapplication/ld+json
memberArray of objects(TicketingOffer.jsonld-v1.offer.read)required
member[].​@contextstring or objectread-only
One of:
stringread-only
member[].​@idstringread-only
member[].​@typestringread-only
member[].​idstring
Example: "0194ad2c-491c-7c9e-b842-10ee940ed6a3"
member[].​datestring or null(date-time)
Example: "2025-01-27"
member[].​availableQuantityinteger or null
Example: 4000
member[].​realtimePriceRequiredboolean
member[].​priceobject(OfferPrice.jsonld-v1.offer.read)
member[].​productobject(TicketingProduct.jsonld-v1.offer.read)

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.

member[].​ticketsArray of objects(TicketingOfferTicket.jsonld-v1.offer.read)
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 TicketingOffer resource.

Request

Retrieves a TicketingOffer resource.

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

Catalog identifier

idstring[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/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

TicketingOffer resource

Bodyapplication/ld+json
@contextstring or objectread-only
One of:
stringread-only
@idstringread-only
@typestringread-only
idstring
Example: "0194ad2c-491c-7c9e-b842-10ee940ed6a3"
datestring or null(date-time)
Example: "2025-01-27"
availableQuantityinteger or null
Example: 4000
realtimePriceRequiredboolean
priceobject(OfferPrice.jsonld-v1.offer.read)
productobject(TicketingProduct.jsonld-v1.offer.read)

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.

ticketsArray of objects(TicketingOfferTicket.jsonld-v1.offer.read)
Response
application/ld+json
{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "id": "0194ad2c-491c-7c9e-b842-10ee940ed6a3",
  "date": "2025-01-27",
  "availableQuantity": 4000,
  "realtimePriceRequired": true,
  "price": {
    "@context": "string",
    "@id": "string",
    "@type": "string",
    "amountInclTax": "100.00",
    "originalAmountInclTax": "120.00",
    "currency": "eur"
  },
  "product": {
    "@context": "string",
    "@id": "string",
    "@type": "string",
    "id": "0194ad2c-491c-7c9e-b842-10ee940ed6a3",
    "name": "A great product name",
    "description": "A great product description"
  },
  "tickets": [
    { … }
  ]
}

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