Fetching bookings via the API

How to get booking details of orders completed via TTG checkout.

You can retrieve a booking completed via the TTG white label checkout using the get bookings API . A number of non-breaking changes have been introduced to this API to give additional information about orders made in local currency and with ticket protection.

The following objects are part of the response:

itemsdescriptionStatus
orderIdTTG platform internal orderIdNew
referenceBasket reference associated with the booking
channelIdTTG affiliate channel id for this booking
deliveryDelivery details
deliveryMethodThe delivery method, eg. eticket
statusThe status of the order
totalSalePriceObject containing the sale price and currency that the user paid. Values are in minor units (pence or cents), eg. 2500 = £25.00.
totalSalePriceOfficeSimilar to totalSalePrice, but with the values in the office currency. This object will always be present even if the user paid in the office currency (which is defined as the currency of the location of the venue).New
reservations

Full break down of the product purchased, including seat and venue information. Any prices referenced will be in the currency the user paid.

If seats at different price points were included in the purchase there will be multiple objects within the reservations array, one for each price point.

reservationsOfficeSimilar to reservations but with pricing in the office currency. This object will always be present even if the user paid in the office currency.New
shopperCustomer information captured during the checkout
addressAddress details for the customer if availableDeprecated
orderConfirmationNumberTTG confirmation number
ticketProtectionAddedBoolean value indicating if the customer added ticket protection to their orderNew
ticketProtectionValue

Value of ticket protection fee in the currency the user paid.

NB: This value is available for selected retailers only

New (optional)
giftCardsGift cards issued by this order, one object per card. Always present; an empty array when the order has no gift card. Each card has code (what the customer enters at checkout to redeem it), value (face value at issue), balance (amount left when the booking is fetched) and expirationDate (last day the card can be used, inclusive, as YYYY-MM-DD; null if the card doesn't expire). Amounts are in minor units.New

Gift card orders

A gift card order has deliveryMethod gift_card and a single reservation with quantity 1. The card is in giftCards. Show its code and expirationDate in your own confirmation.

{
  "reference": "TTG12345678",
  "deliveryMethod": "gift_card",
  "status": "confirmed",
  "totalSalePrice": { "value": 2500, "currency": "GBP", "exchangeRate": null },
  "giftCards": [
    {
      "code": "GCXXXXXXXX",
      "expirationDate": "2027-10-21",
      "value": { "value": 2500, "currency": "GBP", "exchangeRate": null },
      "balance": { "value": 2500, "currency": "GBP", "exchangeRate": null }
    }
  ]
}

Excerpt from a staging order; the other booking fields are as for ticket orders.


Did this page help you?