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

If true, the disabled products are returned in the response. If false, the disabled products are not returned in the response. If not specified, the disabled products are not returned in the response.

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

totalItemsinteger, >= 0

searchobject

viewobject

Example:

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

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