Skip to content
/TicketingCatalog

KorusTicket API (1.0.29)

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

BookingOrderItemTicket

A ticket is a single ticket for an OrderItem. A ticket is issued by the OrderItem's Order.

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

TicketingCatalog

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

Operations

List catalogs

Request

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
Security
JWT
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/ticketing/catalogs?page=1&itemsPerPage=10&order%5BcreatedAt%5D=asc' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

TicketingCatalog collection

Bodyapplication/ld+json
totalItemsinteger>= 0
searchobject
viewobject
Example: {"@id":"string","type":"string","first":"string","last":"string","previous":"string","next":"string"}
memberArray of objects(TicketingCatalog.jsonld-v1.catalog.read)required
member[].​@contextstring or object
One of:
string
member[].​@idstringrequired
member[].​@typestringrequired
member[].​idstring
Example: "0194ad2c-491c-7c9e-b842-10ee940ed6a3"
member[].​createdAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
member[].​lastSyncedAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
member[].​namestring
Example: "Groupama Stadium"
member[].​descriptionstring or null

Description of the catalog (HTML string). May be null. Localized content.

Example: "<h1>Explore the stadium's behind-the-scenes on an exclusive Stadium Tour, from the pitch to the locker rooms, through the VIP boxes.</h1>"
member[].​shortDescriptionstring or null

Short description of the catalog (HTML string). May be null. Localized content.

Example: "<b>Experience OL like never before.</b>"
member[].​termsOfUsestring or null

Terms of use of the catalog (HTML string). May be null. Localized content.

Example: "<p>List of terms</p>"
member[].​supportedLanguagesArray of strings
Example: ["fr","en"]
member[].​operationalboolean
member[].​venueVenue.jsonld-v1.catalog.read_noid (object) or null
Any of:
member[].​logoImage.jsonld-v1.catalog.read_noid (object) or null
Any of:
member[].​galleryArray of objects(Image.jsonld-v1.catalog.read_noid)
Response
application/ld+json
{
  "totalItems": 0,
  "search": {
    "@type": "string",
    "template": "string",
    "variableRepresentation": "string",
    "mapping": [ … ]
  },
  "view": {
    "@id": "string",
    "type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "member": [
    { … }
  ]
}

Show a catalog

Request

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
Security
JWT
Path
idstring[0-9a-f]{8}-[0-9a-f]{4}-7[0-9a-f]{3}-[89ab][0...required

Catalog identifier

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

Responses

TicketingCatalog resource

Bodyapplication/ld+json
@contextstring or object
One of:
string
@idstringrequired
@typestringrequired
idstring
Example: "0194ad2c-491c-7c9e-b842-10ee940ed6a3"
createdAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
lastSyncedAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
namestring
Example: "Groupama Stadium"
descriptionstring or null

Description of the catalog (HTML string). May be null. Localized content.

Example: "<h1>Explore the stadium's behind-the-scenes on an exclusive Stadium Tour, from the pitch to the locker rooms, through the VIP boxes.</h1>"
shortDescriptionstring or null

Short description of the catalog (HTML string). May be null. Localized content.

Example: "<b>Experience OL like never before.</b>"
termsOfUsestring or null

Terms of use of the catalog (HTML string). May be null. Localized content.

Example: "<p>List of terms</p>"
supportedLanguagesArray of strings
Example: ["fr","en"]
operationalboolean
venueVenue.jsonld-v1.catalog.read_noid (object) or null
Any of:
logoImage.jsonld-v1.catalog.read_noid (object) or null
Any of:
galleryArray of objects(Image.jsonld-v1.catalog.read_noid)
Response
application/ld+json
{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "id": "0194ad2c-491c-7c9e-b842-10ee940ed6a3",
  "createdAt": "2025-01-27T15:15:20+00:00",
  "lastSyncedAt": "2025-01-27T15:15:20+00:00",
  "name": "Groupama Stadium",
  "description": "<h1>Explore the stadium's behind-the-scenes on an exclusive Stadium Tour, from the pitch to the locker rooms, through the VIP boxes.</h1>",
  "shortDescription": "<b>Experience OL like never before.</b>",
  "termsOfUse": "<p>List of terms</p>",
  "supportedLanguages": [
    "fr",
    "en"
  ],
  "operational": true,
  "venue": {
    "name": "Groupama Stadium",
    "line1": "10 avenue Simone-Veil",
    "line2": "Bâtiment B",
    "postalCode": "69150",
    "city": "Décines-Charpieu",
    "country": "FR",
    "phone": "+33123456789",
    "website": "https://www.puydufou.com",
    "latitude": "46.8930",
    "longitude": "-0.9306"
  },
  "logo": {
    "publicUrl": "https://example.com/logo.png"
  },
  "gallery": [
    { … }
  ]
}

TicketingOffer

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

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

TicketingOfferTicketSession

OfferTicketSession represents the time slot of an OfferTicket.

Operations

TicketingProductBaseOption

Product Base available option

Operations

TicketingProductBaseOptionValue

Product Base available option values

Operations

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.

Operations

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.

Operations