# REST Resource: flightobject

- [Resource: FlightObject](https://developers.google.com/wallet/reference/rest/v1/flightobject#FlightObject)
  - [JSON representation](https://developers.google.com/wallet/reference/rest/v1/flightobject#FlightObject.SCHEMA_REPRESENTATION)
- [BoardingAndSeatingInfo](https://developers.google.com/wallet/reference/rest/v1/flightobject#BoardingAndSeatingInfo)
  - [JSON representation](https://developers.google.com/wallet/reference/rest/v1/flightobject#BoardingAndSeatingInfo.SCHEMA_REPRESENTATION)
- [BoardingDoor](https://developers.google.com/wallet/reference/rest/v1/flightobject#BoardingDoor)
- [ReservationInfo](https://developers.google.com/wallet/reference/rest/v1/flightobject#ReservationInfo)
  - [JSON representation](https://developers.google.com/wallet/reference/rest/v1/flightobject#ReservationInfo.SCHEMA_REPRESENTATION)
- [FrequentFlyerInfo](https://developers.google.com/wallet/reference/rest/v1/flightobject#FrequentFlyerInfo)
  - [JSON representation](https://developers.google.com/wallet/reference/rest/v1/flightobject#FrequentFlyerInfo.SCHEMA_REPRESENTATION)
- [Methods](https://developers.google.com/wallet/reference/rest/v1/flightobject#METHODS_SUMMARY)

## Resource: FlightObject

| JSON representation |
|---|
| ``` { "kind": string, "classReference": { object (`https://developers.google.com/wallet/reference/rest/v1/flightclass#FlightClass`) }, "passengerName": string, "boardingAndSeatingInfo": { object (`https://developers.google.com/wallet/reference/rest/v1/flightobject#BoardingAndSeatingInfo`) }, "reservationInfo": { object (`https://developers.google.com/wallet/reference/rest/v1/flightobject#ReservationInfo`) }, "securityProgramLogo": { object (`https://developers.google.com/wallet/reference/rest/v1/Image`) }, "hexBackgroundColor": string, "id": string, "classId": string, "version": string, "state": enum (`https://developers.google.com/wallet/reference/rest/v1/State`), "barcode": { object (`https://developers.google.com/wallet/reference/rest/v1/Barcode`) }, "messages": [ { object (`https://developers.google.com/wallet/reference/rest/v1/Message`) } ], "validTimeInterval": { object (`https://developers.google.com/wallet/reference/rest/v1/TimeInterval`) }, "locations": [ { object (`https://developers.google.com/wallet/reference/rest/v1/LatLongPoint`) } ], "hasUsers": boolean, "smartTapRedemptionValue": string, "hasLinkedDevice": boolean, "disableExpirationNotification": boolean, "infoModuleData": { object (`https://developers.google.com/wallet/reference/rest/v1/InfoModuleData`) }, "imageModulesData": [ { object (`https://developers.google.com/wallet/reference/rest/v1/ImageModuleData`) } ], "textModulesData": [ { object (`https://developers.google.com/wallet/reference/rest/v1/TextModuleData`) } ], "linksModuleData": { object (`https://developers.google.com/wallet/reference/rest/v1/LinksModuleData`) }, "appLinkData": { object (`https://developers.google.com/wallet/reference/rest/v1/AppLinkData`) }, "rotatingBarcode": { object (`https://developers.google.com/wallet/reference/rest/v1/RotatingBarcode`) }, "heroImage": { object (`https://developers.google.com/wallet/reference/rest/v1/Image`) }, "groupingInfo": { object (`https://developers.google.com/wallet/reference/rest/v1/GroupingInfo`) }, "passConstraints": { object (`https://developers.google.com/wallet/reference/rest/v1/PassConstraints`) }, "saveRestrictions": { object (`https://developers.google.com/wallet/reference/rest/v1/SaveRestrictions`) }, "linkedObjectIds": [ string ], "notifyPreference": enum (`https://developers.google.com/wallet/reference/rest/v1/NotificationSettingsForUpdates`), "valueAddedModuleData": [ { object (`https://developers.google.com/wallet/reference/rest/v1/ValueAddedModuleData`) } ], "merchantLocations": [ { object (`https://developers.google.com/wallet/reference/rest/v1/MerchantLocation`) } ] } ``` |

| Fields ||
|---|---|
| `kind (deprecated)` | `string` > [!WARNING] > This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#flightObject"`. |
| `classReference` | ``object (`https://developers.google.com/wallet/reference/rest/v1/flightclass#FlightClass`)`` A copy of the inherited fields of the parent class. These fields are retrieved during a GET. |
| `passengerName` | `string` Required. Passenger name as it would appear on the boarding pass. eg: "Dave M Gahan" or "Gahan/Dave" or "GAHAN/DAVEM" |
| `boardingAndSeatingInfo` | ``object (`https://developers.google.com/wallet/reference/rest/v1/flightobject#BoardingAndSeatingInfo`)`` Passenger specific information about boarding and seating. |
| `reservationInfo` | ``object (`https://developers.google.com/wallet/reference/rest/v1/flightobject#ReservationInfo`)`` Required. Information about flight reservation. |
| `securityProgramLogo` | ``object (`https://developers.google.com/wallet/reference/rest/v1/Image`)`` An image for the security program that applies to the passenger. |
| `hexBackgroundColor` | `string` The background color for the card. If not set the dominant color of the hero image is used, and if no hero image is set, the dominant color of the logo is used. The format is #<var translate="no">rrggbb</var> where <var translate="no">rrggbb</var> is a hex RGB triplet, such as `#ffcc00`. You can also use the shorthand version of the RGB triplet which is #<var translate="no">rgb</var>, such as `#fc0`. |
| `id` | `string` Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format <var translate="no">issuer ID</var>.<var translate="no">identifier</var> where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'. |
| `classId` | `string` Required. The class associated with this object. The class must be of the same type as this object, must already exist, and must be approved. Class IDs should follow the format <var translate="no">issuer ID</var>.<var translate="no">identifier</var> where the former is issued by Google and latter is chosen by you. |
| `version (deprecated)` | `string (https://developers.google.com/discovery/v1/type-format format)` > [!WARNING] > This item is deprecated! Deprecated |
| `state` | ``enum (`https://developers.google.com/wallet/reference/rest/v1/State`)`` Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. |
| `barcode` | ``object (`https://developers.google.com/wallet/reference/rest/v1/Barcode`)`` The barcode type and value. |
| `messages[]` | ``object (`https://developers.google.com/wallet/reference/rest/v1/Message`)`` An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. |
| `validTimeInterval` | ``object (`https://developers.google.com/wallet/reference/rest/v1/TimeInterval`)`` The time period this object will be `active` and object can be used. An object's state will be changed to `expired` when this time period has passed. |
| `locations[] (deprecated)` | ``object (`https://developers.google.com/wallet/reference/rest/v1/LatLongPoint`)`` > [!WARNING] > This item is deprecated! Note: This field is currently not supported to trigger geo notifications. |
| `hasUsers` | `boolean` Indicates if the object has users. This field is set by the platform. |
| `smartTapRedemptionValue` | `string` The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. |
| `hasLinkedDevice` | `boolean` Whether this object is currently linked to a single device. This field is set by the platform when a user saves the object, linking it to their device. Intended for use by select partners. Contact support for additional information. |
| `disableExpirationNotification` | `boolean` Indicates if notifications should explicitly be suppressed. If this field is set to true, regardless of the `messages` field, expiration notifications to the user will be suppressed. By default, this field is set to false. Currently, this can only be set for Flights. |
| `infoModuleData` | ``object (`https://developers.google.com/wallet/reference/rest/v1/InfoModuleData`)`` Deprecated. Use textModulesData instead. |
| `imageModulesData[]` | ``object (`https://developers.google.com/wallet/reference/rest/v1/ImageModuleData`)`` Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level. |
| `textModulesData[]` | ``object (`https://developers.google.com/wallet/reference/rest/v1/TextModuleData`)`` Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. |
| `linksModuleData` | ``object (`https://developers.google.com/wallet/reference/rest/v1/LinksModuleData`)`` Links module data. If links module data is also defined on the class, both will be displayed. |
| `appLinkData` | ``object (`https://developers.google.com/wallet/reference/rest/v1/AppLinkData`)`` Optional app or website link that will be displayed as a button on the front of the pass. If AppLinkData is provided for the corresponding class only object AppLinkData will be displayed. |
| `rotatingBarcode` | ``object (`https://developers.google.com/wallet/reference/rest/v1/RotatingBarcode`)`` The rotating barcode type and value. |
| `heroImage` | ``object (`https://developers.google.com/wallet/reference/rest/v1/Image`)`` Optional banner image displayed on the front of the card. If none is present, hero image of the class, if present, will be displayed. If hero image of the class is also not present, nothing will be displayed. |
| `groupingInfo` | ``object (`https://developers.google.com/wallet/reference/rest/v1/GroupingInfo`)`` Information that controls how passes are grouped together. |
| `passConstraints` | ``object (`https://developers.google.com/wallet/reference/rest/v1/PassConstraints`)`` Pass constraints for the object. Includes limiting NFC and screenshot behaviors. |
| `saveRestrictions` | ``object (`https://developers.google.com/wallet/reference/rest/v1/SaveRestrictions`)`` Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. |
| `linkedObjectIds[]` | `string` linkedObjectIds are a list of other objects such as event ticket, loyalty, offer, generic, giftcard, transit and boarding pass that should be automatically attached to this flight object. If a user had saved this boarding pass, then these linkedObjectIds would be automatically pushed to the user's wallet (unless they turned off the setting to receive such linked passes). Make sure that objects present in linkedObjectIds are already inserted - if not, calls would fail. Once linked, the linked objects cannot be unlinked. You cannot link objects belonging to another issuer. There is a limit to the number of objects that can be linked to a single object. After the limit is reached, new linked objects in the call will be ignored silently. Object IDs should follow the format <var translate="no">issuer ID</var>.<var translate="no">identifier</var> where the former is issued by Google and the latter is chosen by you. |
| `notifyPreference` | ``enum (`https://developers.google.com/wallet/reference/rest/v1/NotificationSettingsForUpdates`)`` Whether or not field updates to this object should trigger notifications. When set to NOTIFY, we will attempt to trigger a field update notification to users. These notifications will only be sent to users if the field is part of an allowlist. If set to DO_NOT_NOTIFY or NOTIFICATION_SETTINGS_UNSPECIFIED, no notification will be triggered. This setting is ephemeral and needs to be set with each PATCH or UPDATE request, otherwise a notification will not be triggered. |
| `valueAddedModuleData[]` | ``object (`https://developers.google.com/wallet/reference/rest/v1/ValueAddedModuleData`)`` Optional value added module data. Maximum of ten on the object. |
| `merchantLocations[]` | ``object (`https://developers.google.com/wallet/reference/rest/v1/MerchantLocation`)`` Merchant locations. There is a maximum of ten on the object. Any additional MerchantLocations added beyond the 10 will be rejected. These locations will trigger a notification when a user enters within a Google-set radius of the point. This field replaces the deprecated LatLongPoints. |

## BoardingAndSeatingInfo

| JSON representation |
|---|
| ``` { "kind": string, "boardingGroup": string, "seatNumber": string, "seatClass": string, "boardingPrivilegeImage": { object (`https://developers.google.com/wallet/reference/rest/v1/Image`) }, "boardingPosition": string, "sequenceNumber": string, "boardingDoor": enum (`https://developers.google.com/wallet/reference/rest/v1/flightobject#BoardingDoor`), "seatAssignment": { object (`https://developers.google.com/wallet/reference/rest/v1/LocalizedString`) } } ``` |

| Fields ||
|---|---|
| `kind (deprecated)` | `string` > [!WARNING] > This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#boardingAndSeatingInfo"`. |
| `boardingGroup` | `string` The value of boarding group (or zone) this passenger shall board with. eg: "B" The label for this value will be determined by the `boardingPolicy` field in the `flightClass` referenced by this object. |
| `seatNumber` | `string` The value of passenger seat. If there is no specific identifier, use `seatAssignment` instead. eg: "25A" |
| `seatClass` | `string` The value of the seat class. eg: "Economy" or "Economy Plus" |
| `boardingPrivilegeImage` | ``object (`https://developers.google.com/wallet/reference/rest/v1/Image`)`` A small image shown above the boarding barcode. Airlines can use it to communicate any special boarding privileges. In the event the security program logo is also set, this image might be rendered alongside the logo for that security program. |
| `boardingPosition` | `string` The value of boarding position. eg: "76" |
| `sequenceNumber` | `string` The sequence number on the boarding pass. This usually matches the sequence in which the passengers checked in. Airline might use the number for manual boarding and bag tags. eg: "49" |
| `boardingDoor` | ``enum (`https://developers.google.com/wallet/reference/rest/v1/flightobject#BoardingDoor`)`` Set this field only if this flight boards through more than one door or bridge and you want to explicitly print the door location on the boarding pass. Most airlines route their passengers to the right door or bridge by refering to doors/bridges by the `seatClass`. In those cases `boardingDoor` should not be set. |
| `seatAssignment` | ``object (`https://developers.google.com/wallet/reference/rest/v1/LocalizedString`)`` The passenger's seat assignment. To be used when there is no specific identifier to use in `seatNumber`. eg: "assigned at gate" |

## BoardingDoor

| Enums ||
|---|---|
| `BOARDING_DOOR_UNSPECIFIED` |   |
| `FRONT` |   |
| `front` | Legacy alias for `FRONT`. Deprecated. > [!WARNING] > This item is deprecated! |
| `BACK` |   |
| `back` | Legacy alias for `BACK`. Deprecated. > [!WARNING] > This item is deprecated! |

## ReservationInfo

| JSON representation |
|---|
| ``` { "kind": string, "confirmationCode": string, "eticketNumber": string, "frequentFlyerInfo": { object (`https://developers.google.com/wallet/reference/rest/v1/flightobject#FrequentFlyerInfo`) } } ``` |

| Fields ||
|---|---|
| `kind (deprecated)` | `string` > [!WARNING] > This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#reservationInfo"`. |
| `confirmationCode` | `string` Confirmation code needed to check into this flight. This is the number that the passenger would enter into a kiosk at the airport to look up the flight and print a boarding pass. |
| `eticketNumber` | `string` E-ticket number. |
| `frequentFlyerInfo` | ``object (`https://developers.google.com/wallet/reference/rest/v1/flightobject#FrequentFlyerInfo`)`` Frequent flyer membership information. |

## FrequentFlyerInfo

| JSON representation |
|---|
| ``` { "kind": string, "frequentFlyerProgramName": { object (`https://developers.google.com/wallet/reference/rest/v1/LocalizedString`) }, "frequentFlyerNumber": string } ``` |

| Fields ||
|---|---|
| `kind (deprecated)` | `string` > [!WARNING] > This item is deprecated! Identifies what kind of resource this is. Value: the fixed string `"walletobjects#frequentFlyerInfo"`. |
| `frequentFlyerProgramName` | ``object (`https://developers.google.com/wallet/reference/rest/v1/LocalizedString`)`` Frequent flyer program name. eg: "Lufthansa Miles \& More" |
| `frequentFlyerNumber` | `string` Frequent flyer number. Required for each nested object of kind `walletobjects#frequentFlyerInfo`. |

| ## Methods ||
|---|---|
| ### `https://developers.google.com/wallet/reference/rest/v1/flightobject/addmessage` | Adds a message to the flight object referenced by the given object ID. |
| ### `https://developers.google.com/wallet/reference/rest/v1/flightobject/get` | Returns the flight object with the given object ID. |
| ### `https://developers.google.com/wallet/reference/rest/v1/flightobject/insert` | Inserts an flight object with the given ID and properties. |
| ### `https://developers.google.com/wallet/reference/rest/v1/flightobject/list` | Returns a list of all flight objects for a given issuer ID. |
| ### `https://developers.google.com/wallet/reference/rest/v1/flightobject/patch` | Updates the flight object referenced by the given object ID. |
| ### `https://developers.google.com/wallet/reference/rest/v1/flightobject/update` | Updates the flight object referenced by the given object ID. |