Skip to content
/BookingOrder

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

Retrieves the collection of BookingOrder resources.

Request

Retrieves the collection of BookingOrder resources.

Security
JWT
Query
pageinteger

The collection page number

Default 1
itemsPerPageinteger[ 0 .. 50 ]

The number of items per page

Default 10
external_referencestring^.{1,50}$

Filter by external reference

order[createdAt]string

Order by createdAt

Enum"asc""desc"
createdAt[after]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...
createdAt[strictly_after]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...
createdAt[before]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...
createdAt[strictly_before]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...
curl -i -X GET \
  'https://api.demo.korusticket.com/v1/booking/orders?page=1&itemsPerPage=10&external_reference=string&order%5BcreatedAt%5D=asc&createdAt%5Bafter%5D=string&createdAt%5Bstrictly_after%5D=string&createdAt%5Bbefore%5D=string&createdAt%5Bstrictly_before%5D=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

BookingOrder collection

Bodyapplication/ld+json
memberArray of objectsrequired
member[].​idstring
Example: "0194cb22-b891-754c-8c4c-777b93f8d072"
member[].​createdAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
member[].​catalogstring
Example: "/v1/ticketing/catalogs/0194cb23-170e-71f0-b4bb-0a7e644dea34"
member[].​organizationstring
Example: "/v1/organizations/0194cb23-170e-71f0-b4bb-0a7e644dea34"
member[].​referencestring
Example: "KT-ORD-123456"
member[].​externalReferencestring or null
Example: "YOUR-CUSTOM-REFERENCE"
member[].​connectorReferencestring or null
member[].​totalAmountInclTaxstring
Example: "100.00"
member[].​totalAmountExclTaxstring
Example: "100.00"
member[].​customerobject(OrderCustomer.jsonld-v1.order.read)
member[].​statusstring
Enum"confirmed""cancelled"
member[].​cancelledAtstring or null(date-time)
Example: "2025-02-27T15:15:20+00:00"
member[].​itemsArray of objects(OrderItem.jsonld-v1.order.read)
member[].​documentsArray of strings(iri-reference)
Example: ["https://example.com/"]
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 BookingOrder resource.

Request

Creates a BookingOrder resource.

Security
JWT
Bodyapplication/ld+jsonrequired

The new BookingOrder resource

reservationsArray of stringsnon-empty
customerobject(CreateOrderInputCustomer.jsonld-v1.order.create_bulk_write)
externalReferencestring<= 255 charactersrequired
curl -i -X POST \
  https://api.demo.korusticket.com/v1/booking/orders/_bulk \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/ld+json' \
  -d '{
    "reservations": [
      "string"
    ],
    "customer": {
      "firstname": "john",
      "lastname": "doe",
      "email": "[email protected]",
      "phone": "+33610203040",
      "country": "FR",
      "language": "fr",
      "optin": true,
      "title": "mr"
    },
    "externalReference": "string"
  }'

Responses

BookingOrder resource created

Bodyapplication/ld+json
ordersArray of objects(BookingOrder.jsonld-v1.order.create_bulk_read_v1.order.read)
failedOrdersArray of objects(FailedOrder.jsonld-v1.order.create_bulk_read_v1.order.read)
Response
application/ld+json
{
  "orders": [
    { … }
  ],
  "failedOrders": [
    { … }
  ]
}

Retrieves a BookingOrder resource.

Request

Retrieves a BookingOrder resource.

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

Order identifier

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

Responses

BookingOrder resource

Bodyapplication/ld+json
idstring
Example: "0194cb22-b891-754c-8c4c-777b93f8d072"
createdAtstring(date-time)
Example: "2025-01-27T15:15:20+00:00"
catalogstring
Example: "/v1/ticketing/catalogs/0194cb23-170e-71f0-b4bb-0a7e644dea34"
organizationstring
Example: "/v1/organizations/0194cb23-170e-71f0-b4bb-0a7e644dea34"
referencestring
Example: "KT-ORD-123456"
externalReferencestring or null
Example: "YOUR-CUSTOM-REFERENCE"
connectorReferencestring or null
totalAmountInclTaxstring
Example: "100.00"
totalAmountExclTaxstring
Example: "100.00"
customerobject(OrderCustomer.jsonld-v1.order.read)
statusstring
Enum"confirmed""cancelled"
cancelledAtstring or null(date-time)
Example: "2025-02-27T15:15:20+00:00"
itemsArray of objects(OrderItem.jsonld-v1.order.read)
documentsArray of strings(iri-reference)
Example: ["https://example.com/"]
Response
application/ld+json
{
  "id": "0194cb22-b891-754c-8c4c-777b93f8d072",
  "createdAt": "2025-01-27T15:15:20+00:00",
  "catalog": "/v1/ticketing/catalogs/0194cb23-170e-71f0-b4bb-0a7e644dea34",
  "organization": "/v1/organizations/0194cb23-170e-71f0-b4bb-0a7e644dea34",
  "reference": "KT-ORD-123456",
  "externalReference": "YOUR-CUSTOM-REFERENCE",
  "connectorReference": "string",
  "totalAmountInclTax": "100.00",
  "totalAmountExclTax": "100.00",
  "customer": {
    "firstname": "john",
    "lastname": "doe",
    "email": "[email protected]",
    "phone": "+33610203040",
    "optin": true,
    "country": "FR",
    "language": "fr",
    "title": "mr"
  },
  "status": "confirmed",
  "cancelledAt": "2025-02-27T15:15:20+00:00",
  "items": [
    { … }
  ],
  "documents": [
    "https://example.com/"
  ]
}

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