Skip to content
/BookingOrder

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
referencestring^.{1,50}$

Filter by reference

externalReferencestring^.{1,50}$

Filter by external reference

qstring

Case-insensitive partial match on reference or external reference

statusstring

Filter by order status

Enum:"confirmed""cancelled"
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...

BookingOrder createdAt[after]

createdAt[strictly_after]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...

BookingOrder createdAt[strictly_after]

createdAt[before]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...

BookingOrder createdAt[before]

createdAt[strictly_before]string[0-9]{4}-(?:0[1-9]|1[012])-(?:0[1-9]|[12][0-9...

BookingOrder createdAt[strictly_before]

voucherstring^.{1,50}$

Filter by ticket voucher

curl -i -X GET \
  'https://api.demo.korusticket.com/v1/booking/orders?page=1&itemsPerPage=10&reference=string&externalReference=string&q=string&status=confirmed&order%5BcreatedAt%5D=asc&createdAt%5Bafter%5D=string&createdAt%5Bstrictly_after%5D=string&createdAt%5Bbefore%5D=string&createdAt%5Bstrictly_before%5D=string&voucher=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

BookingOrder collection

Bodyapplication/ld+json
totalItemsinteger, >= 0
searchobject
viewobject
Example:
{
  "@id": "string",
  "@type": "string",
  "first": "string",
  "last": "string",
  "previous": "string",
  "next": "string"
}
memberArray of objects(BookingOrder.jsonld-v1.order.read)required
Response
{
  "totalItems": 0,
  "search": {
    "@type": "string",
    "template": "string",
    "variableRepresentation": "string",
    "mapping": [ … ]
  },
  "view": {
    "@id": "string",
    "@type": "string",
    "first": "string",
    "last": "string",
    "previous": "string",
    "next": "string"
  },
  "member": [
    { … }
  ]
}