Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Offers List

...

Event

Properties

Note

Status

1

Page View

Name

: Offers
  • Path: /rewards/offers

  • Status
    colourGreen
    titleAVAILABLE

    2

    Button

    • Name: Account

    • Path: /rewards/offers

    Status
    colourRed
    titleNOT AVAILABLE YET

    3

    Button

    • Name: Rewards

    • Path:/rewards/offers

    Status
    colourRed
    titleNOT AVAILABLE YET

    4

    Link

    • Name: Choose Your Location

    • Path:/rewards/offers

    Status
    colourRed
    titleNOT AVAILABLE YET

    5

    Tab

    • Name: All Offers

    • Path:/rewards/offers

    Status
    colourRed
    titleNOT AVAILABLE YET

    6

    Tab

    • Name: External Offers

    • Path:/rewards/offers

    Status
    colourRed
    titleNOT AVAILABLE YET

    7

    Tab

    • Name: Favorites

    • Path:/rewards/offers

    Status
    colourRed
    titleNOT AVAILABLE YET

    8

    Button

    • Name: Have a Promo Code?

    • Path:/rewards/offers

    Status
    colourRed
    titleNOT AVAILABLE YET

    9

    List Item

    • Name: Offer Name

    • Engine ID: Offer Engine ID

    • Sanity ID: Offer Sanity ID

    • Service Mode: pickup , delivery

    • Path:/rewards/offers

    • Type: All Offer, External Offer,Favorited Offers

    Event is triggered when user clicks

    Status
    colourRed
    titleNOT AVAILABLE YET

    Offer Detail Page

    ...

    ...

    Event

    ...

    Properties

    ...

    Note

    ...

    Page View

    ...

    • Name: Offer Detail

    • Path: /rewards/offers/offerID

    ...

    • offerID Offer link

    Example: 7d9b4e42-0b74-45d8-b4fc-2c86d04b0f0d

    ...

    Button

    ...

    • Name: Account

    • Path: /rewards/offers/offerID

    ...

    Button

    ...

    • Name: Rewards

    • Path:/rewards/offers/offerID

    ...

    Link

    ...

    • Name: Choose Your Location

    • Path:/rewards/offers/offerID

    ...

    Button

    ...

    • Name: Favorite

    • Path:/rewards/offers/offerID

    ...

    Button

    ...

    • Name: Mobile Order

    • Path:/rewards/offers/offerID

    ...

    Button

    ...

    • Name: Redeem In-Store

    • Path:/rewards/offers/offerID

    External Offer Detail Page

    ...

    ...

    Event

    ...

    Properties

    ...

    Note

    ...

    Page View

    ...

    • Name: External Offer Detail

    • Path: /rewards/offers/offerID

    ...

    • offerID External Offer link

    Example: 7d9b4e42-0b74-45d8-b4fc-2c86d04b0f0d

    ...

    Button

    ...

    • Name: Back

    • Path: /rewards/offers/offerID

    ...

    Button

    ...

    • Name: Favorite

    • Path:/rewards/offers/offerID

    ...

    Button

    ...

    • Name: Mobile Order

    • Path:/rewards/offers/offerID

    ...

    The label button changes depending on the external offer partner.

    ...

    Button

    ...

    • Name: Terms and Conditions

    • Path:/rewards/offers/offerID

    External Offer Modal

    ...

    Event

    Properties

    Note

    1

    Modal

    • Name: Access External Offer

    • Path: /rewards/offers/offerID

    • offerID External Offer link

    Example: 7d9b4e42-0b74-45d8-b4fc-2c86d04b0f0d

    2

    Button

    • Name: Yes

    • Path: /rewards/offers/offerID

    3

    Button

    • Name: Not Now

    • Path:/rewards/offers/offerID

    Event Name

    Description

    Properties

    Property Description

    Offer Selected

    User clicked on an offer from the offers list and saw the offer description.

    (warning) Replaces the deprecated Offer click event.

    name

    Offer name, e.g. “£4.99 CHICKEN or VEGAN ROYAL”

    sanityId

    Sanity ID of the offer

    Offer Added to Order

    User added a reward to their order cart. When redemptionMode is In-Store, this event is triggered when the user clicks on the “Use at restaurant“ button.

    (warning) Replaces the deprecated Restaurant Offer selected event.

    Same as Offer Selected

    Same as Offer Selected

    redemptionMode

    Can be either In-Store or Online.

    Offer Favorite Added

    User clicked on the heart to favourite an offer.

    Same as Offer Selected

    Same as Offer Selected

    storeId

    ID of the currently selected store, if any.

    Offer Favorite Removed

    User clicked on the heart to un-favourite an offer.

    Same as Offer Selected

    Same as Offer Favorite Added

    Description

    Properties

    Property Description

    Offer Selected

    Triggered when an offer is selected.

    name

    The locale specific name of the offer clicked. e.g. "6 Chilli Cheese"

    isLoyaltUser

    True

    sanityId

    The Sanity ID of the offer clicked. e.g. "b0cde124-241b-4831-a191-26c269d31e2d"

    engineId

    The Loyalty Engine ID of the offer clicked. e.g. "d94bf6cc-1850-48fd-817c-934051423835"

    redemptionMode

    E.g. Online

    pickupMode

    E.g. Take Out

    serviceMode

    E.g. Pickup

    Button Click - Add to Order (Mobile Order)

    Triggered after the user adds an offer to Pick Up or Delivery.

    name

    Add to Mobile Order

    currentScreen

    E.g.: /rewards/offers/7d09b162-781d-4e74-9d2f-b0c212574b6b

    Source Page

    redeem/

    Button Click - Redeem In Restaurant (In-Store)

    Triggered after the user adds an offer to be redeemed in the restaurant.

    name

    Redeem In Restaurant

    currentScreen

    E.g.: /rewards/offers/7d09b162-781d-4e74-9d2f-b0c212574b6b

    Source Page

    redeem/

    Button Click - Remove Offer applied to Mobile Order

    Triggered when the user removes the offer from the Pick Up/Delivery order from the Offers List.

    name

    Remove

    Offer Favorite Added

    Triggered after the user favorited an offer.

    name

    The locale specific name of the offer clicked. e.g. "6 Chilli Cheese"

    isLoyaltUser

    True

    sanityId

    The Sanity ID of the offer clicked. e.g. "b0cde124-241b-4831-a191-26c269d31e2d"

    engineId

    The Loyalty Engine ID of the offer clicked. e.g. "d94bf6cc-1850-48fd-817c-934051423835"

    pickupMode

    E.g. Take Out

    serviceMode

    E.g. Pickup

    Button Click - Select a Tab

    Triggered when a section tab is clicked.

    name

    Favorites , All Offers