List offers by catalog

Request

Attributes details

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

order[date]string

Order by date

Enum:"asc""desc"

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

TicketingOffer date[after]

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

TicketingOffer date[strictly_after]

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

TicketingOffer date[before]

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

TicketingOffer date[strictly_before]

product[]Array of strings

Filter by product

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

Filter by product base ID

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

Filter by session

optionValuesContext[]Array of strings

Filter by option values

includeNotReservablebooleantrue|false

Include expired and sold-out offers

curl -i -X GET \
  'https://api.demo.korusticket.com/v1/ticketing/catalogs/{catalogId}/offers?page=1&itemsPerPage=10&order%5Bdate%5D=asc&date%5Bafter%5D=string&date%5Bstrictly_after%5D=string&date%5Bbefore%5D=string&date%5Bstrictly_before%5D=string&product%5B%5D=string&productBaseId=string&session=string&optionValuesContext%5B%5D=string&includeNotReservable=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

TicketingOffer collection

Bodyapplication/ld+json

totalItemsinteger, >= 0

searchobject

viewobject

Example:

{
  "@id": "string",
  "@type": "string",
  "first": "string",
  "last": "string",
  "previous": "string",
  "next": "string"
}

memberArray of objects(TicketingOffer.jsonld-v1.offer.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": [
    { … }
  ]
}