v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1495145304.5 KB
offerobject

Returns the offer object with the given object ID.

get/walletobjects/v1/offerObject/{resourceId}

Path parameters

resourceIdstring 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. Your unique identifier should only include alphanumeric characters, '.', '_', or '-'.

Response

Successful response

classIdstring

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.

disableExpirationNotificationboolean

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.

hasLinkedDeviceboolean

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.

hasUsersboolean

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

idstring

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

kindstring

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

smartTapRedemptionValuestring

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.

state'STATE_UNSPECIFIED' | 'ACTIVE' | 'active' | 'COMPLETED' | 'completed' | 'EXPIRED' | 'expired' | 'INACTIVE' | 'inactive'

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.

versionstring int64

Deprecated