Skip to content
/BookingOrderItemTicket

KorusTicket API (1.0.19)

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

Retrieves a BookingOrderItemTicket resource.

Request

Retrieves a BookingOrderItemTicket resource.

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

Order identifier

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

Order item identifier

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

Ticket identifier

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

Responses

BookingOrderItemTicket resource

Bodyapplication/ld+json
@contextstring or object
One of:
string
@idstringrequired
@typestringrequired
idstring
Example: "0194cb22-b891-754c-8c4c-777b93f8d072"
voucherstring or null
occursAtstring or null(date-time)
Example: "2025-02-27T15:15:20+00:00"
requiredBeneficiaryFieldsArray of strings
Example: ["firstname","lastname"]
beneficiaryOrderItemTicketBeneficiary.jsonld-v1.order_item_ticket.read (object) or null
Any of:
beneficiaryDesignationDeadlinestring or null(date-time)
beneficiaryAmendableboolean
statusstring
Enum"waiting_beneficiary_data""validated"
seatingTicketSeating.jsonld-v1.order_item_ticket.read (object) or null
Any of:
object(TicketSeating.jsonld-v1.order_item_ticket.read)
Response
application/ld+json
{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "id": "0194cb22-b891-754c-8c4c-777b93f8d072",
  "voucher": "string",
  "occursAt": "2025-02-27T15:15:20+00:00",
  "requiredBeneficiaryFields": [
    "firstname",
    "lastname"
  ],
  "beneficiary": {
    "firstname": "John",
    "lastname": "Doe",
    "email": "[email protected]",
    "phone": "+33610203040",
    "title": "mr",
    "dateOfBirth": "2000-01-01",
    "placeOfBirth": "Aix-en-Provence",
    "nationality": "FR"
  },
  "beneficiaryDesignationDeadline": "2019-08-24T14:15:22Z",
  "beneficiaryAmendable": true,
  "status": "waiting_beneficiary_data",
  "seating": {}
}

Updates the BookingOrderItemTicket resource.

Request

Updates the BookingOrderItemTicket resource.

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

Order identifier

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

Order item identifier

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

Ticket identifier

Bodyapplication/merge-patch+jsonrequired

The updated BookingOrderItemTicket resource

beneficiaryobject(PatchItemTicketBeneficiaryInput-v1.order_item_ticket.patch)
curl -i -X PATCH \
  'https://api.demo.korusticket.com/v1/booking/orders/{orderId}/items/{orderItemId}/tickets/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/merge-patch+json' \
  -d '{
    "beneficiary": {
      "firstname": "john",
      "lastname": "doe",
      "title": "mr",
      "nationality": "FR",
      "dateOfBirth": "2000-01-01",
      "placeOfBirth": "string",
      "email": "string",
      "phone": "string"
    }
  }'

Responses

BookingOrderItemTicket resource updated

Bodyapplication/ld+json
@contextstring or object
One of:
string
@idstringrequired
@typestringrequired
idstring
Example: "0194cb22-b891-754c-8c4c-777b93f8d072"
voucherstring or null
occursAtstring or null(date-time)
Example: "2025-02-27T15:15:20+00:00"
requiredBeneficiaryFieldsArray of strings
Example: ["firstname","lastname"]
beneficiaryOrderItemTicketBeneficiary.jsonld-v1.order_item_ticket.read (object) or null
Any of:
beneficiaryDesignationDeadlinestring or null(date-time)
beneficiaryAmendableboolean
statusstring
Enum"waiting_beneficiary_data""validated"
seatingTicketSeating.jsonld-v1.order_item_ticket.read (object) or null
Any of:
object(TicketSeating.jsonld-v1.order_item_ticket.read)
Response
application/ld+json
{
  "@context": "string",
  "@id": "string",
  "@type": "string",
  "id": "0194cb22-b891-754c-8c4c-777b93f8d072",
  "voucher": "string",
  "occursAt": "2025-02-27T15:15:20+00:00",
  "requiredBeneficiaryFields": [
    "firstname",
    "lastname"
  ],
  "beneficiary": {
    "firstname": "John",
    "lastname": "Doe",
    "email": "[email protected]",
    "phone": "+33610203040",
    "title": "mr",
    "dateOfBirth": "2000-01-01",
    "placeOfBirth": "Aix-en-Provence",
    "nationality": "FR"
  },
  "beneficiaryDesignationDeadline": "2019-08-24T14:15:22Z",
  "beneficiaryAmendable": true,
  "status": "waiting_beneficiary_data",
  "seating": {}
}

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

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