List available inventory items | TTG Developer Portal

curl -G https://stg.ttix.io/api/v3/events/123/occurrences/456/inventory-items \
     -H "X-TT-Platform: android" \
     -H "X-TT-API-Key: <apiKey>" \
     -d providerCode=campaign-may \
     -d currency=GBP \
     -d quantity=2 \
     -d voucherCode=PRESALE24 \
     -d limit=50 \
     -d offset=0

{
  "data": [
    {
      "id": "v1_AQAAAAPoAAAABk9yY2hlc3RyYS1BLTEwMQ",
      "inventoryVariant": {
        "_type": "AssignedSeat",
        "id": "Orchestra-A-101",
        "name": "Orchestra A 101",
        "section": "Orchestra",
        "row": "A",
        "seat": "101",
        "attributes": []
      },
      "quantityAvailable": 1,
      "selectionGroup": {
        "inventoryItemIds": [
          "v1_AQAAAAPoAAAABk9yY2hlc3RyYS1BLTEwMQ",
          "v1_AQAAAAPoAAAABk9yY2hlc3RyYS1BLTEwMg"
        ]
      },
      "priceOptions": [
        {
          "id": "SeeTickets:FULL",
          "category": {
            "name": "Adult"
          },
          "listPrice": {
            "amount": 15000,
            "currency": "USD"
          },
          "sellPrice": {
            "amount": 17000,
            "currency": "USD"
          },
          "fees": [
            {
              "type": "SERVICE_FEE",
              "value": {
                "amount": 600,
                "currency": "USD"
              }
            }
          ]
        }
      ]
    },
    {
      "id": "v1_AQAAAAPoAAAABkZsb29yIEdB",
      "inventoryVariant": {
        "_type": "GeneralAdmission",
        "id": "General-Admission",
        "name": "General Admission",
        "attributes": []
      },
      "quantityAvailable": 50,
      "priceOptions": [
        {
          "id": "42",
          "category": {
            "name": "Adult"
          },
          "sellPrice": {
            "amount": 9500,
            "currency": "USD"
          }
        },
        {
          "id": "43",
          "category": {
            "name": "Child"
          },
          "sellPrice": {
            "amount": 6500,
            "currency": "USD"
          }
        }
      ]
    },
    {
      "id": "invitem-extra-wine",
      "inventoryVariant": {
        "_type": "Extra",
        "id": "var-extra-white-wine",
        "name": "White Wine",
        "attributes": []
      },
      "quantityAvailable": 100,
      "priceOptions": [
        {
          "id": "po-standard",
          "category": {
            "name": "Standard"
          },
          "listPrice": {
            "amount": 15000,
            "currency": "USD"
          },
          "sellPrice": {
            "amount": 1320,
            "currency": "USD"
          }
        }
      ]
    },
    {
      "id": "v1_AQAAAAPoAAAAB1ByZW1pdW0",
      "inventoryVariant": {
        "_type": "GeneralAdmission",
        "id": "PREMIUM",
        "name": "Premium",
        "description": "Front-of-stage standing",
        "attributes": []
      },
      "quantityAvailable": 0,
      "priceOptions": []
    },
    {
      "id": "v1_AQAAAAABAAAAFFRPREFZVElYIEdJRlQgQ0FSRC01MDAw",
      "inventoryVariant": {
        "_type": "GiftCard",
        "id": "TODAYTIX GIFT CARD-5000",
        "name": "TodayTix Gift Card",
        "value": {
          "amount": 5000,
          "currency": "GBP"
        },
        "attributes": []
      },
      "quantityAvailable": 100,
      "priceOptions": [
        {
          "id": "po-gift-card-50",
          "category": {
            "name": "Standard"
          },
          "sellPrice": {
            "amount": 4500,
            "currency": "GBP"
          },
          "listPrice": {
            "amount": 5000,
            "currency": "GBP"
          },
          "discountPercentage": 10
        }
      ]
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "total": 5
  }
}

Returns a paginated list of the inventory an occurrence lists for sale, plus any sold-out area kept on display (see the end of this description). Use the inventoryVariant._type field to differentiate between item types:

AssignedSeat — specific physical seat (section, row, seat number)
GeneralAdmission — GA area with available quantity
Extra — Extra (drinks, merchandise, parking)
GiftCard — one denomination of a gift card, carrying the balance it is issued with in value. A gift-card event returns one item per denomination, and its occurrence and venue are bookkeeping placeholders: do not render a date, a time or a venue for one.

InventoryVariant.id is stable across all occurrences, enabling seating chart integration.

Send the currency query parameter to receive prices in that currency. Omit it to get base-currency prices. A currency this event is not sold in returns 400; one it is sold in but that cannot be priced right now (no exchange rate) returns 503.

Send the quantity query parameter to shape the list around a party of that size; omit it to see all inventory. Inventory the party cannot buy is dropped, with one exception: an AssignedSeat that is in stock but not sold to a party of that size stays listed with selectionBlocked.chainSize, the quantity that would work; show it as unavailable and do not add it to a cart. Every other AssignedSeat carries selectionGroup.inventoryItemIds: the items to add to the cart together when the customer picks that seat. Pagination applies to the shaped list, so fetch every page with the same quantity.

Send the voucherCode query parameter with a presale or access code to include the inventory sold only to holders of that code, priced with the code applied. A code that is not valid for this event is ignored rather than rejected, so the response is the same as without it.

A GeneralAdmission area that has sold out but is configured to stay listed is returned with quantityAvailable 0 and an empty priceOptions, after every purchasable item. Show it as unavailable; it cannot be added to a cart.

Returns a paginated list of the inventory an occurrence lists for sale, plus any sold-out area kept on display (see the end of this description). Use the `inventoryVariant._type` field to differentiate between item types: - `AssignedSeat` — specific physical seat (section, row, seat number) - `GeneralAdmission` — GA area with available quantity - `Extra` — Extra (drinks, merchandise, parking) - `GiftCard` — one denomination of a gift card, carrying the balance it is issued with in `value`. A gift-card event returns one item per denomination, and its occurrence and venue are bookkeeping placeholders: do not render a date, a time or a venue for one. `InventoryVariant.id` is stable across all occurrences, enabling seating chart integration. Send the `currency` query parameter to receive prices in that currency. Omit it to get base-currency prices. A currency this event is not sold in returns `400`; one it is sold in but that cannot be priced right now (no exchange rate) returns `503`. Send the `quantity` query parameter to shape the list around a party of that size; omit it to see all inventory. Inventory the party cannot buy is dropped, with one exception: an AssignedSeat that is in stock but not sold to a party of that size stays listed with `selectionBlocked.chainSize`, the quantity that would work; show it as unavailable and do not add it to a cart. Every other AssignedSeat carries `selectionGroup.inventoryItemIds`: the items to add to the cart together when the customer picks that seat. Pagination applies to the shaped list, so fetch every page with the same quantity. Send the `voucherCode` query parameter with a presale or access code to include the inventory sold only to holders of that code, priced with the code applied. A code that is not valid for this event is ignored rather than rejected, so the response is the same as without it. A `GeneralAdmission` area that has sold out but is configured to stay listed is returned with `quantityAvailable` 0 and an empty `priceOptions`, after every purchasable item. Show it as unavailable; it cannot be added to a cart.

Authentication

X-TT-API-Keystring

API Key authentication via header

Path parameters

eventIdstringRequiredformat: "^[1-9]\d*$">=1 character

occurrenceIdstringRequiredformat: "^[1-9]\d*$">=1 character

Query parameters

providerCodestringOptionalformat: ".*\S.*"0-255 characters

Optional provider code identifying which configured pricing tier should price this request. Retailers running concurrent pricing tiers on a single credential use this to select among them. Omitting the code prices at the default tier; a code not configured for this event and retailer is rejected with a 404 naming the code.

currencystringOptionalformat: "^[A-Z]{3}$"

ISO 4217 currency to price in. Omit for the event base currency. A currency this event is not sold in returns 400; one it is sold in but that cannot be priced right now returns 503.

quantitystringOptional

Number of tickets the party needs. Seats the whole party can sit in together carry a selectionGroup; seats in stock but not sold at that size carry selectionBlocked; general admission areas without enough tickets remaining are dropped. Omit to see all inventory.

voucherCodestringOptionalformat: ".*\S.*"0-15 characters

Presale or access code the shopper has entered. Inventory sold only to holders of this code is included and priced with the code applied. A code this event does not recognize is ignored: the response is the same as without it. A blank code, or one longer than 15 characters, is rejected with a 400.

limitstringRequired

Maximum number of results to return.

offsetstringRequired

Number of results to skip for pagination.

Response

Paginated list of available inventory items.

AssignedSeat — specific physical seat (section, row, seat number)
GeneralAdmission — GA area with available quantity
Extra — Extra (drinks, merchandise, parking)
GiftCard — one denomination of a gift card, carrying the balance it is issued with in value. A gift-card event returns one item per denomination, and its occurrence and venue are bookkeeping placeholders: do not render a date, a time or a venue for one.

InventoryVariant.id is stable across all occurrences, enabling seating chart integration.

Authentication

Path parameters

Headers

Query parameters

Response