/walletobjects/v1/transitObject

GET

transitobject

Returns a list of all transit objects for a given issuer ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://walletobjects.googleapis.com//walletobjects/v1/transitObject'

Response Example

Request

Query Params

classId

string

optional

The ID of the class whose objects will be listed.

maxResults

integer

optional

Identifies the max number of results returned by a list. All results are returned if maxResults isn't defined.

token

string

optional

Used to get the next set of results if maxResults is specified, but more than maxResults objects are available in a list. For example, if you have a list of 200 objects and you call list with maxResults set to 20, list will return the first 20 objects and a token. Call list again with maxResults set to 20 and the token to get the next 20 objects.

Responses

🟢200Successful response

application/json

Body

pagination

object (Pagination)

optional

Pagination of the response.

kind

string

optional

Identifies what kind of resource this is. Value: the fixed string "walletobjects#pagination".

nextPageToken

string

optional

Page token to send to fetch the next page.

resultsPerPage

integer <int32>

optional

Number of results returned in this page.

resources

array[object (TransitObject) {33}]

optional

Resources corresponding to the list request.

appLinkData

object (AppLinkData)

optional

Optional information about the partner app link.

barcode

object (Barcode)

optional

The barcode type and value.

classId

string

optional

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 issuer ID.identifier where the former is issued by Google and latter is chosen by you.

classReference

object (TransitClass)

optional

A copy of the inherited fields of the parent class. These fields are retrieved during a GET.

concessionCategory

enum<string>

optional

The concession category for the ticket.

Allowed values:

CONCESSION_CATEGORY_UNSPECIFIEDADULTadultCHILDchildSENIORsenior

customConcessionCategory

object (LocalizedString)

optional

A custom concession category to use when concessionCategory does not provide the right option. Both concessionCategory and customConcessionCategory may not be set.

customTicketStatus

object (LocalizedString)

optional

A custom status to use for the ticket status value when ticketStatus does not provide the right option. Both ticketStatus and customTicketStatus may not be set.

disableExpirationNotification

boolean

optional

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 offers.

hasLinkedDevice

boolean

optional

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.

hasUsers

boolean

optional

Indicates if the object has users. This field is set by the platform.

heroImage

object (Image)

optional

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.

hexBackgroundColor

string

optional

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 #rrggbb where rrggbb is a hex RGB triplet, such as #ffcc00. You can also use the shorthand version of the RGB triplet which is #rgb, such as #fc0.

string

optional

Required. The unique identifier for an object. This ID must be unique across all objects from an issuer. This value should follow the format issuer ID.identifier where the former is issued by Google and latter is chosen by you. The unique identifier should only include alphanumeric characters, '.', '_', or '-'.

imageModulesData

array[object (ImageModuleData) {2}]

optional

Image module data. The maximum number of these fields displayed is 1 from object level and 1 for class object level.

infoModuleData

object (InfoModuleData)

optional

Deprecated. Use textModulesData instead.

linksModuleData

object (LinksModuleData)

optional

Links module data. If links module data is also defined on the class, both will be displayed.

locations

array[object (LatLongPoint) {3}]

optional

The list of locations where the object can be used. The platform uses this information to trigger geolocated notifications to users. Note that locations in the object override locations in the class which override locations in the Google Places ID.

messages

array[object (Message) {8}]

optional

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.

passengerNames

string

optional

The name(s) of the passengers the ticket is assigned to. The above passengerType field is meant to give Google context on this field.

passengerType

enum<string>

optional

The number of passengers.

Allowed values:

PASSENGER_TYPE_UNSPECIFIEDSINGLE_PASSENGERsinglePassengerMULTIPLE_PASSENGERSmultiplePassengers

purchaseDetails

object (PurchaseDetails)

optional

Purchase details for this ticket.

smartTapRedemptionValue

string

optional

Available only to Smart Tap enabled partners. Contact support for additional guidance.

state

enum<string>

optional

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.

Allowed values:

STATE_UNSPECIFIEDACTIVEactiveCOMPLETEDcompletedEXPIREDexpiredINACTIVEinactive

textModulesData

array[object (TextModuleData) {5}]

optional

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.

ticketLeg

object (TicketLeg)

optional

A single ticket leg contains departure and arrival information along with boarding and seating information. If more than one leg is to be specified then use the ticketLegs field instead. Both ticketLeg and ticketLegs may not be set.

ticketLegs

array[object (TicketLeg) {14}]

optional

Each ticket may contain one or more legs. Each leg contains departure and arrival information along with boarding and seating information. If only one leg is to be specified then use the ticketLeg field instead. Both ticketLeg and ticketLegs may not be set.

ticketNumber

string

optional

The number of the ticket. This is a unique identifier for the ticket in the transit operator's system.

ticketRestrictions

object (TicketRestrictions)

optional

Information about what kind of restrictions there are on using this ticket. For example, which days of the week it must be used, or which routes are allowed to be taken.

ticketStatus

enum<string>

optional

The status of the ticket. For states which affect display, use the state field instead.

Allowed values:

TICKET_STATUS_UNSPECIFIEDUSEDusedREFUNDEDrefundedEXCHANGEDexchanged

tripId

string

optional

This id is used to group tickets together if the user has saved multiple tickets for the same trip.

tripType

enum<string>

optional

Required. The type of trip this transit object represents. Used to determine which symbol to use between the origin and destination.

Allowed values:

TRIP_TYPE_UNSPECIFIEDROUND_TRIProundTripONE_WAYoneWay

validTimeInterval

object (TimeInterval)

optional

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.

version

string <int64>

optional

Deprecated

/walletobjects/v1/transitClass/{resourceId}/addMessage

/walletobjects/v1/transitObject