Get Booking

This endpoint is for fetching the details of a booking

Request

Security:

JWT

path Parameters

bookingId

required

string

Id of the booking in Tyro Connect that should be retrieved

header Parameters

Authorization required	string Default: Bearer {$$.env.access_token}
Accept required	string (acceptHeaderBooking1_0) Default: application/vnd.tyro.connect+json;version=0.1 Specifies which version of the API to use. If no value is provided then 0.1 version will be used Enum: "application/vnd.tyro.connect+json;version=1.0" "application/vnd.tyro.connect+json;version=0.1"

Responses

200

The booking response

403

When you don't have the right permissions to create a booking for the provided location

404

When the provided bookingId does not match a booking stored in the system

get/bookings/{bookingId}

Request samples

curl
C#
Node.js

curl -i -X GET \
  'https://api.tyro.com/connect/bookings/{bookingId}' \
  -H 'Accept: application/vnd.tyro.connect+json;version=1.0' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"id": "2688fcf2-44dd-4c72-88ac-79d0910f2983",
"locationId": "merchant:abc123",
"origin": {"bookingReference": "some-booking-reference"
},
"customer": {"id": "85GFA95D",
"name": "Jennifer Wicks",
"notes": "Birthday breakfast"
},
"startTime": "2020-12-01T08:00:00+10:00",
"endTime": "2020-12-01T10:00:00+10:00",
"bookingStatus": "ACCEPTED",
"numberOfPeople": 2,
"payments": [{"amount": 4321,
"currency": "AUD",
"description": "Reservation payment"
}
],
"asset": {"type": "TABLE",
"tableStatus": "SEATED",
"tables": [{"number": "1"
}
],
"discounts": ["Summer Sale 10% off"
],
"preOrders": ["1x breakfast roll",
"4x flat whites"
]
},
"createdAt": "2021-05-04T08:00:00+10:00",
"updatedAt": "2021-05-04T10:00:00+10:00"
}