Skip to content
/TicketingProductBase

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

List product bases

Request

Attributes details

Name

Name of the product base.

Description

Description of the product base (HTML string). Localized content.

ShortDescription

Short description of the product base (HTML string). Localized content.

TermsOfUse

Terms of use of the product base (HTML string). Localized content.

UseSession

Indicates whether offers associated with this product base require selecting a session.

Timezone

Timezone in which the event takes place (e.g. Europe/Paris).

Recurring

Indicates whether offers for this product base are recurring (multiple dates).

BeneficiaryInfoMayBeRequired

Indicates whether beneficiary information may be required on tickets to generate order documents.

InstantDocumentDelivery

Indicates whether order documents are available for immediate download.

MaxAmountPerOrder

The maximum number of offers allowed in a single order.

Universe

Universe of the product base (e.g. show).

Venue

Venue information for the product base.

  • name: Venue name
  • line1, line2: Address lines
  • postalCode, city, country: Address details
  • phone, website: Contact information
  • latitude, longitude: Geographic coordinates (decimal degrees, returned as strings)

Medias content

  • logo: Logo image if available
  • gallery: Gallery images ordered by position
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
withDisabledbooleantrue|false

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

Example:withDisabled=true
curl -i -X GET \
  'https://api.demo.korusticket.com/v1/ticketing/catalogs/{catalogId}/product_bases?page=1&itemsPerPage=10&withDisabled=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

TicketingProductBase collection

Bodyapplication/ld+json
totalItemsinteger, >= 0
searchobject
viewobject
Example:
{
  "@id": "string",
  "@type": "string",
  "first": "string",
  "last": "string",
  "previous": "string",
  "next": "string"
}
memberArray of objects(TicketingProductBase.jsonld-v1.product_base.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": [
    { … }
  ]
}