API Details

Endpoints Reference

POST /bookings/{bookingId}/boardingpasses

Retrieve boarding passes for all passengers on a booking.

Path Parameters:

Parameter	Type	Required	Description
bookingId	string	Yes	The NewSkies booking record locator (PNR)

Query Parameters:

Parameter	Type	Required	Description
lastname	string	No	Passenger last name for booking validation
outboundDate	string	No	Outbound flight date (format: yyyyMMdd)
checkedInOnly	boolean	No	Return only checked-in passengers
checkNameAndOutboundDate	boolean	No	Validate lastname and outbound date match
fetchFirstBookingOnly	boolean	No	Return only the first matching booking

Example Request:

curl -X POST "https://test.api.tui/flight-newskies-boardingpass/bookings/ABC123/boardingpasses?lastname=Smith&outboundDate=20260815&checkedInOnly=true" \
  -H "Authorization: Bearer <token>" \
  -H "X-SourceMarket: uk"

---

POST /bookings/{bookingId}/barcode

Generate an IATA BCBP-compliant barcode for a specific passenger and segment.

Path Parameters:

Parameter	Type	Required	Description
bookingId	string	Yes	Booking record locator

Query Parameters:

Parameter	Type	Required	Description
lastname	string	No	Passenger last name
outboundDate	string	No	Outbound date (format: yyyyMMdd)
type	string	No	Barcode type
segment	string	No	Flight segment identifier
paxNo	integer	No	Passenger number (0-based index)

---

POST /bookings/{bookingId}/pdf

Generate a PDF boarding pass document.

Path Parameters:

Parameter	Type	Required	Description
bookingId	string	Yes	Booking record locator

Query Parameters:

Parameter	Type	Required	Description
lastname	string	No	Passenger last name
outboundDate	string	No	Outbound date (format: yyyyMMdd)
segment	array[string]	No	Segment indices to include
paxNo	array[integer]	No	Passenger numbers to include
showSource	boolean	No	Include source market branding

Response: Binary PDF file content.

---

POST /bookings/{bookingId}/pkpass

Generate an Apple Wallet boarding pass (pkpass format).

Path Parameters:

Parameter	Type	Required	Description
bookingId	string	Yes	Booking record locator

Query Parameters:

Parameter	Type	Required	Description
lastname	string	No	Passenger last name
outboundDate	string	No	Outbound date (format: yyyyMMdd)
segment	string	No	Segment identifier
paxNo	integer	No	Passenger number

Response: Binary pkpass file content (application/vnd.apple.pkpass).

---

POST /bookings/{bookingId}/googlePayPass

Generate a Google Pay boarding pass.

Path Parameters:

Parameter	Type	Required	Description
bookingId	string	Yes	Booking record locator

Query Parameters:

Parameter	Type	Required	Description
lastname	string	No	Passenger last name
outboundDate	string	No	Outbound date (format: yyyyMMdd)
segment	string	No	Segment identifier
paxNo	integer	No	Passenger number

Response Codes:

Code	Description
201	Pass created successfully
400	Invalid parameters (returns ProblemDetails)

---

POST /bookings/{bookingId}/email

Send boarding pass documents to specified recipients via email.

Path Parameters:

Parameter	Type	Required	Description
bookingId	string	Yes	Booking record locator

Query Parameters:

Parameter	Type	Required	Description
lastname	string	No	Passenger last name
outboundDate	string	No	Outbound date (format: yyyyMMdd)
attach	string	No	Attachment type
segment	array[string]	No	Segment indices
paxNo	array[integer]	No	Passenger numbers
recipient	array[string]	No	Email addresses to send to

Note: This endpoint is protected by an additional email quota policy.

---

GET /bookings/{bookingId}/checkinstatus

Get the check-in status of passengers on a booking.

Path Parameters:

Parameter	Type	Required	Description
bookingId	string	Yes	Booking record locator

Query Parameters:

Parameter	Type	Required	Description
segment	string	No	Specific segment to query
departureDate	string	No	Departure date filter

Example Response:

[
  {
    "flightNumber": "BY1234",
    "departureStation": "LGW",
    "arrivalStation": "PMI",
    "departureStationName": "London Gatwick",
    "arrivalStationName": "Palma de Mallorca",
    "passengers": [
      {
        "firstName": "John",
        "lastName": "Smith",
        "checkedIn": true,
        "passengerId": 1
      }
    ]
  }
]

---

GET /settings/availability/{origin}/{destination}/{airline}/{date}

Check whether online check-in is available for a specific route and date.

Path Parameters:

Parameter	Type	Required	Description
origin	string	Yes	IATA departure airport code (e.g., LGW)
destination	string	Yes	IATA arrival airport code (e.g., PMI)
airline	string	Yes	Airline carrier code (e.g., BY)
date	string	Yes	Flight date (format: yyyyMMdd)

Query Parameters:

Parameter	Type	Required	Description
flight	string	No	Specific flight number

---

GET /settings/checkinconfig/{carrierCode}

Retrieve check-in configuration rules for a carrier.

Path Parameters:

Parameter	Type	Required	Description
carrierCode	string	Yes	Airline carrier code (e.g., BY, X3)

Query Parameters:

Parameter	Type	Required	Description
departureStation	string	No	IATA departure airport code
arrivalStation	string	No	IATA arrival airport code
countryFrom	string	No	Departure country code
countryTo	string	No	Arrival country code
flightNumber	string	No	Flight number
ssr	string	No	Special service request code

Example Response:

{
  "adoc": true,
  "mobileBP": true,
  "printableBP": true,
  "checkInOpens": 24,
  "checkInCloses": 2,
  "logInOpens": 48,
  "logInCloses": 2,
  "logInAutoSeated": 24
}

---

GET /settings/generalsettings

Retrieve general configuration settings.

Query Parameters:

Parameter	Type	Required	Description
channel	string	No	Channel filter
carrierCode	string	No	Carrier code filter
module	string	No	Module filter

---

POST /settings/autodoccheck/{origin}/{destination}/{airline}

Check if automatic document verification applies for a route.

Path Parameters:

Parameter	Type	Required	Description
origin	string	Yes	IATA departure airport code
destination	string	Yes	IATA arrival airport code
airline	string	Yes	Carrier code

---

POST /settings/webcheckin/{origin}/{destination}/{airline}/{date}

Check web check-in eligibility for a specific route and date.

Path Parameters:

Parameter	Type	Required	Description
origin	string	Yes	IATA departure airport code
destination	string	Yes	IATA arrival airport code
airline	string	Yes	Carrier code
date	string	Yes	Flight date (format: yyyyMMdd)

Query Parameters:

Parameter	Type	Required	Description
flight	string	No	Specific flight number

---

POST /system/ping

Health check endpoint. Returns 200 if the service is operational.

---

Data Models

CheckInConfig

Field	Type	Description
adoc	boolean	Automatic document check enabled
mobileBP	boolean	Mobile boarding pass enabled
printableBP	boolean	Printable boarding pass enabled
checkInOpens	integer	Hours before departure when check-in opens
checkInCloses	integer	Hours before departure when check-in closes
logInOpens	integer	Hours before departure when login opens (nullable)
logInCloses	integer	Hours before departure when login closes (nullable)
logInAutoSeated	integer	Hours before departure for auto-seating (nullable)

CheckInStatusModel

Field	Type	Description
flightNumber	string	Flight number (e.g., BY1234)
departureStation	string	IATA departure airport code
arrivalStation	string	IATA arrival airport code
departureStationName	string	Full departure airport name
arrivalStationName	string	Full arrival airport name
passengers	array	List of passenger check-in states

Passenger

Field	Type	Description
firstName	string	Passenger first name
lastName	string	Passenger last name
checkedIn	boolean	Whether passenger is checked in
passengerId	long	Passenger identifier

ProblemDetails (Error Response)

Field	Type	Description
type	string	Error type URI
title	string	Error title
status	integer	HTTP status code
detail	string	Error detail message