Get Product Availability Group

GET 
/catalogues/availabilitygroups/:id

Gets a product availability group based, and optionally filters on category.

Request

Path Parameters

id stringrequired

The id of the availability group

Query Parameters

page integerrequired

Default value: 1

pageSize integerrequired

Default value: 50

category string[]

Optionally, filter by a given product category

Header Parameters

x-api-key stringrequired

The API key for the given store

Accept-Language string

Default value: en

Responses

200

The request has succeeded.

application/json

Schema

Schema

results object[]required
Array [
id stringrequired
The id of the product
name stringrequired
The name of the product. i.e "Coca Cola 375ml"
type object
Product Type
state object
Product State
visibility object
Product Visibility
purchaseLimits object
Purchase Limits - can be per contact OR per order
perContact integer
Limit per contact
perOrder integer
Limit per order
ticketingProduct object
Represents the additional information that comes on a ticketing product
type TicketingTypeEnumrequired
Possible values: [TicketedEvent, SeasonTicket]
The type of ticketing product this product represents
eventType EventTypeEnumrequired
Possible values: [SportsMatch]
If a TicketEvent type, then this indicates what sort of ticketed event.
isHospitality booleanrequired
Whether the ticketing product is a hospitality product or not.
name stringrequired
start stringrequired
end stringrequired
sportsMatch objectrequired
The ticketed event represents a sports match. The line item will have specific details that are relevant to sports matches.
competition objectrequired
Which competition the match is part of
name stringrequired
The name of the competition (Premier League 2021, Champions League 2021, etc)
season objectrequired
Sports Season
name stringrequired
start string
end string
competitionType objectrequired
Competition Type
name stringrequired
logoImageUrl stringrequired
hostTeam objectrequired
The home team
id stringrequired
The id of the team
name stringrequired
The name of the team
logoImageUrl string
The team crest
opponentTeam objectrequired
The away team
id stringrequired
The id of the team
name stringrequired
The name of the team
logoImageUrl string
The team crest
rates object[]required
The rates that apply to a ticketed event.
Array [
id stringrequired
The id of the rate
seatCategory objectrequired
The seat category which the rate applies to
id stringrequired
The id of the seat category
name stringrequired
The name of the seat category, i.e Block A, Block B, etc
rank integerrequired
The sort order of the seat category
tariff objectrequired
The tariff that the rate applies to
id stringrequired
The id of the tariff
name stringrequired
The name of the tarrif, i.e Adult, Junior, Senior, etc
rank integerrequired
The sort order of the tariff
price objectrequired
The price of the rate
minorUnits int32required
The amount of money, in it's ISO 4217 minor units (i.e. cents, pence, etc)
currencyCode stringrequired
The currency of the money value
precision int32required
The precision of the money value (i.e it's minor units conversion factor) based on IOS 4217
available integerrequired
]
venue objectrequired
The venue that the ticketed event is at.
name stringrequired
address objectrequired
Venue Address
addressLine1 stringrequired
addressLine2 stringrequired
postCode stringrequired
city stringrequired
countryIso stringrequired
coordinates objectrequired
Venue Coordinates
longitude stringrequired
latitude stringrequired
consumableProduct object
Represents the additional information that comes on a consumable product
description stringrequired
A short description about the consumable.
shortName stringrequired
Short name for the consumable
brand stringrequired
The brand of the product
size stringrequired
The size of the product, for example in ml or grams
barcode stringrequired
The scannable barcode of the product
allergens stringrequired
Any allergens that the product contains
categories string[]required
The product category that the product belongs to
price objectrequired
The price of the product
minorUnits int32required
The amount of money, in it's ISO 4217 minor units (i.e. cents, pence, etc)
currencyCode stringrequired
The currency of the money value
precision int32required
The precision of the money value (i.e it's minor units conversion factor) based on IOS 4217
tax objectrequired
Money
minorUnits int32required
The amount of money, in it's ISO 4217 minor units (i.e. cents, pence, etc)
currencyCode stringrequired
The currency of the money value
precision int32required
The precision of the money value (i.e it's minor units conversion factor) based on IOS 4217
imageUrl uri
Optional product image
energy integer
calories integer
eligibilities object[]required
The eligibilities that apply to this product.
Array [
id stringrequired
type EligibilityTypeEnumrequired
Possible values: [Ticketing]
Eligibility Type
eligibleFrom date-time
eligibleUntil date-time
name stringrequired
conditionEvaluation EligibilityConditionEvaluationEnumrequired
Possible values: [NotEvaluated, Eligible, Ineligible, ContactRequired, ProviderSideContactRequired]
Eligibility Condition Evaluation
purchaseLimitPerContact integerrequired
purchaseLimitPerOrder integerrequired
]
saleStartDate stringrequired
Date from when the product is available for purchase
tags string[]required
Product Tags
]
page integerrequired
pageSize integerrequired
totalResults integerrequired
categories objectrequired
property name* integer

Example (from schema)

{
  "results": [
    {
      "id": "string",
      "name": "string",
      "type": "Ticketing",
      "state": "Inactive",
      "visibility": "IfEligible",
      "purchaseLimits": {
        "perContact": 0,
        "perOrder": 0
      },
      "ticketingProduct": {
        "type": "TicketedEvent",
        "eventType": "SportsMatch",
        "isHospitality": true,
        "name": "string",
        "start": "string",
        "end": "string",
        "sportsMatch": {
          "competition": {
            "name": "string",
            "season": {
              "name": "string",
              "start": "string",
              "end": "string"
            },
            "competitionType": {
              "name": "string",
              "logoImageUrl": "string"
            }
          },
          "hostTeam": {
            "id": "string",
            "name": "string",
            "logoImageUrl": "string"
          },
          "opponentTeam": {
            "id": "string",
            "name": "string",
            "logoImageUrl": "string"
          }
        },
        "rates": [
          {
            "id": "string",
            "seatCategory": {
              "id": "string",
              "name": "string",
              "rank": 0
            },
            "tariff": {
              "id": "string",
              "name": "string",
              "rank": 0
            },
            "price": {
              "minorUnits": 0,
              "currencyCode": "string",
              "precision": 0
            },
            "available": 0
          }
        ],
        "venue": {
          "name": "string",
          "address": {
            "addressLine1": "string",
            "addressLine2": "string",
            "postCode": "string",
            "city": "string",
            "countryIso": "string"
          },
          "coordinates": {
            "longitude": "string",
            "latitude": "string"
          }
        }
      },
      "consumableProduct": {
        "description": "string",
        "shortName": "string",
        "brand": "string",
        "size": "string",
        "barcode": "string",
        "allergens": "string",
        "categories": [
          "string"
        ],
        "price": {
          "minorUnits": 0,
          "currencyCode": "string",
          "precision": 0
        },
        "tax": {
          "minorUnits": 0,
          "currencyCode": "string",
          "precision": 0
        },
        "imageUrl": "string",
        "energy": 0,
        "calories": 0
      },
      "eligibilities": [
        {
          "id": "string",
          "type": "Ticketing",
          "eligibleFrom": "2024-01-12T12:47:19.318Z",
          "eligibleUntil": "2024-01-12T12:47:19.318Z",
          "name": "string",
          "conditionEvaluation": "NotEvaluated",
          "purchaseLimitPerContact": 0,
          "purchaseLimitPerOrder": 0
        }
      ],
      "saleStartDate": "string",
      "tags": [
        "string"
      ]
    }
  ],
  "page": 0,
  "pageSize": 0,
  "totalResults": 0,
  "categories": {}
}

401

Access is unauthorized.

Loading...