Skip to content
/TicketingProduct

KorusTicket API (1.0.10)

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

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

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

Retrieves the collection of TicketingProduct resources.

Request

Retrieves the collection of TicketingProduct resources.

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

Catalog identifier

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

Product base identifier

Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 50 ]

The number of items per page

Default 10
withDisabledbooleantrue|false
Example: withDisabled=true
optionValuesContext[]Array of strings

Filter by option values

curl -i -X GET \
  'https://api.demo.korusticket.com/v1/ticketing/catalogs/{catalogId}/product_bases/{productBaseId}/products?page=1&itemsPerPage=10&withDisabled=true&optionValuesContext%5B%5D=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

TicketingProduct collection

Bodyapplication/ld+json
memberArray of objectsrequired
member[].​idstring
Example: "0194ad2c-491c-7c9e-b842-10ee940ed6a3"
member[].​namestring
Example: "A great product name"
member[].​descriptionstring
Example: "A great product description"
member[].​disabledboolean
member[].​optionsArray of objects(TicketingProductBaseOption.jsonld-v1.product.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 the collection of TicketingProduct resources.

Request

Retrieves the collection of TicketingProduct resources.

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

Filter by product base

Example: productBase=0194ad2c-491c-7c9e-b842-10ee940ed6a3
withDisabledbooleantrue|false
Example: withDisabled=true
curl -i -X GET \
  'https://api.demo.korusticket.com/v1/ticketing/catalogs/{catalogId}/products?page=1&itemsPerPage=10&productBase=0194ad2c-491c-7c9e-b842-10ee940ed6a3&withDisabled=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

TicketingProduct collection

Bodyapplication/ld+json
memberArray of objectsrequired
member[].​idstring
Example: "0194ad2c-491c-7c9e-b842-10ee940ed6a3"
member[].​namestring
Example: "A great product name"
member[].​descriptionstring
Example: "A great product description"
member[].​disabledboolean
member[].​optionsArray of objects(TicketingProductBaseOption.jsonld-v1.product.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 TicketingProduct resource.

Request

Retrieves a TicketingProduct resource.

Security
JWT
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

Product identifier

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

Responses

TicketingProduct resource

Bodyapplication/ld+json
idstring
Example: "0194ad2c-491c-7c9e-b842-10ee940ed6a3"
namestring
Example: "A great product name"
descriptionstring
Example: "A great product description"
disabledboolean
optionsArray of objects(TicketingProductBaseOption.jsonld-v1.product.read)
Response
application/ld+json
{
  "id": "0194ad2c-491c-7c9e-b842-10ee940ed6a3",
  "name": "A great product name",
  "description": "A great product description",
  "disabled": true,
  "options": [
    { … }
  ]
}