AvailableOffer

An offer that is available for application as a part of an API response when using the POS API loyalty flow. Typically represents an entry in a user's digital offer wallet.

  • name
    Type: string
    required

    A user-friendly display name for this offer.

  • offer_id
    Type: string
    required

    A unique identifier for this offer. This value should be used when sending SelectedOffers to the API as part of the POS API loyalty flow.

  • valid_now
    Type: boolean
    required

    Whether or not the offer can be applied to the current transaction.

  • expiration_date
    Type: stringFormat: date-time

    ISO-8601 format timestamp for when the offer expires. Blank for non-expiring entries.

  • invalid_reason
    Type: string

    A user-friendly display message to be used when valid_now is false.