Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.

Antavo’s Offer management module delivers pre-purchase incentives to selected customers both online and offline. You can create cart or item discounts in the Backoffice so that we Antavo can provide the necessary offer information that your customers can choose right at the checkout. Antavo can enable the redemption of offers by giving you The Offers API endpoint and Display API serve you with the list of applicable offers on a cart, but you need to implement the solution in your checkout process that reduces the actual basket value based on the settings of an applicable the offer.

...

Table of Contents

Find the configuration page of the Offers module by clicking on the Price tag (blue star) icon in the sidebar or typing “Offers” to 'Offers' into the search bar of the Modules (blue star) menu. The page will open to a list of offers that are already set up.

...

up with the following information:

  • Name

  • Type

  • Status - active or inactive

...

Setting up a new offer

  • Click the ‘Create new offer’ button on in the Offer management sidebar .

...

  • of the Offers module page

  • Add the name of the offer:
    This will be the name of the offer on the Antavo Backoffice and you can also use the Offers API to request this information.

  • Set the type of the offer to create:

    • Cart offer
      The cart type of offer applies a discount on the basket value of the purchase on the condition that the cart contains specific products and/or the basket value is between the predefined minimum and maximum values.

    • Item offer
      The item type of offer applies a discount on an item or on items in the cart. The application of the discount can optionally be restricted to a minimum and maximum basket value.

    • Combined offer
      The combined offer applies a discount on an item or on items if the cart contains specific products and/or the basket value is between the predefined minimum and maximum values.

Common settings of all offer types

  • Add the priority of the offer in the ‘Weight’ Weight field
    The priority defines the displayed order of the offers, the lower number means higher priority.

  • Select a coupon pool if you want Antavo to assign coupons to offers based on pools you have already created in the Backoffice, you can select one from the dropdown menu. Coupons module
    When the coupon pool has been selected the help text displays information on the source, type, and amount settings of the pool and the number of coupon combinations available.

...

Restrictions

Based on the restrictions set below (except for the ‘Exclusive’ checkbox) Antavo filters the list of applicable offers when providing them through the Offers API.

  • Recurring checkbox:

    Check the ‘Recurring’ box if you want to make the offer recurring
    Recurring offers can happen:

    • weekly

      - define here

      – select the recurring

      days

      day(s) from Monday to Sunday for your offer and the start and end time of the day

    • monthly

      - define here

      – select the recurring calendar

      days

      day(s) for your offer and the start and end time of the day

    • yearly

      - define here

      – select the recurring month

      , days

      (s), day(s), and the start and end time of the day

    • Nightly Recurring - When you mark the 'Nightly Recurring' checkbox, it adjusts the calculation to include the following day for the end time. For instance, if you select Monday and set an end time of 1:30 AM, the end time will be on Tuesday at 1:30 AM.
      This also applies if the end time is earlier in the day

      Redemption than the start time. For example, if it's set for Monday and the start time is 12:30 AM, while the end time is 1:30 AM, then it won't run until Tuesday at 1:30 AM.

...

  • Define the redemption start and end date
    These settings are only applicable in case the Recurring checkbox is turned off

    , you

    . You can use them to set the timeframe in which customers can redeem this offer.
    Please note

    ,

    that offers cannot be redeemed before the issuance start date (find instructions below), even if the redemption start date is an earlier date.

  • Number

    Set the number of applications and the customer’s redemption frequency

    • Set the number of times the offer can be redeemed per customer in the

      ‘Number

      Number of applications' configuration field

      . Leave empty for no limit.
      Example:


      eg. In case you’d restrict customers to have the offer applied to only 5 of their purchases, set the

      Number

      number of applications to

      '5'

      5.
      Leave empty for no limit.

    • Set the number of times the offer can be redeemed per customer within a week, a month, or a year in the ‘Redemption frequency’ configuration fields
      eg.


      Example:

      In case you’d let customers apply the offer on their purchases only once a week, set the

      Redemption

      redemption frequency to

      ‘1

      1 per

      week’

      week.

Info

...

Antavo can only filter the offers based on the

...

Number of

...

application and

...

Redemption frequency values if you provide offer redemption information in the transactional data that you send through the Events API.

  • Segments

    Define the segments and/or lists that can use this offer

    .


    In case you add more segments, the offer will be available for customers who are members of any of the segments added.

  • Stores
    Define your brand's stores that

    Select the stores where customers can use this offer

    .


    Leave empty for no restriction.
    Store restriction is only available if you have added your stores in the

    Store Management

    Stores module.

  • Exclusive

    Turn on the ‘Exclusive’ option
    Offers can be added as exclusive, which means that they cannot be used together with any other offer in the same checkout.

...

Cart

  • Add a minimum and maximum total basket value Use the ‘Min total’ and ‘Max total’ fields to restrict the availability of offers to specific limited cart totals

...

  • Discount

Discount

  • Select the discount type of the offer

    • Fixed price

    • Fixed discount

    • Percentage discount

  • Set the value
    Define the discount to be applied on to the cart total or on specific item(s) in the cart.

    • Type

      • Fixed price

      • Fixed discount

      • Percentage discount

    • Value

...

Offer card

If you’d like to

...

display the offer on the membership site, fill in the fields below

...

so that

...

Antavo can provide all the necessary information via Display API.

  • Enabled

    Enable the offer on the membership site
    In case this option is not enabled, the Display API will not add the offer to the API response when you query the list of the available offers for a specific customer.

  • Title
    The title is provided by API endpoints.

  • Description
    The description is provided by API endpoints.

  • Image
  • Add the title of the offer

  • Write a description

  • Upload an image
    The image is provided by API endpoints in 3 sizes (small, medium, and large).

    Anchorissuance

    issuance

  • Issuance start date and end date
    The Display API returns the offer in the list of available offers between the end and start date and the offer can be assigned to customers within this timeframe.
    Please note, that offers cannot be redeemed before the issuance start date, even if the redemption start date is an earlier date.

  • Display ‘coming soon’ before the start date
    In case this option is not enabled, the Display API will add the offer to the API response even before the

    Issuance

    issuance start date.

  • Display the offer only for the selected segments
    In case this option is not disabled, the Display API will add the offer to the API response even if the customer is not eligible for the offer based on the

    Segment

    segment restriction.

  • Inventory

    Set the inventory size
    The number of offers available to be assigned per customer or globally, eg.


    Examples:

    In case you’d restrict specific customers to be assigned to the offer up to 5 times, set the inventory to

    ‘5

    5 per customer

    '

    or if you want to assign the offer only 5 times globally, set the inventory to

    '

    5

    globally’

    globally.

  • Issuance

    Set the issuance frequency
    The frequency in which the offer can be assigned to a specific customer per day, per week, per month, or per year, eg.


    Examples:

    In case you’d assign the offer to one specific customer only once a day, set the Issuance frequency to

    ‘1

    1 per day

    '

    .

...

Specific settings of offer types

Required items

...

Applicable to

...

Cart and

...

Combined types of offers

...

only.

Match ‘any’ or ‘all’ option defines if all or at least one of the required items should be added to the card.
You can specify a product

...

(s) added to the Product catalog, or enter a list of product IDs.

Eligible items

...

Applicable to Item and Combined types of offers only.

Match ‘any’ or ‘all’ option defines if all or at least one of the eligible items should be added to the card.
You can specify a product

...

(s) added to the Product catalog, or enter a list of product IDs.

...

Discount

...

Applicable to Item and Combined types of offers only.
Add a Target and a Maximum quantity to the item and combined items where discounts can be applied on item(s) in the cart.

  • Target –

    you can

    grant the discount on all eligible items in the cart, or only on the cheapest/most expensive item

    .

  • Max quantity – set the quantity of eligible item(s) that the offer can

    discount.

...

  • be applied to

...

Saving and activating an offer

Once you have entered all the information required for the offer, save your settings using the ‘Save’ button at the bottom of the setup page. First, the offer will be saved as ‘inactive’, which means the offer will not be forwarded by the Offers API available for customers to use and will appear only in the list of offers in the Offer management configurationBackoffice.
After you have saved your new offer, you can activate it right away using the ‘Set active’ button on the upper right-hand side of the offer setup page and confirm the activation in the dialog that subsequently appears.

...

Managing

...

offers

...

Edit an offer

  • Go Navigate to the Offers Management pagetab

  • Click on the Edit button next to an ‘Edit’ button of the offer you want to edit

  • Edit your offer

  • Click ‘Save’.

...

Deactivate an offer

  • Go Navigate to the Offers Management pagetab

  • Click on the Edit button next to an ‘Edit’ button of the offer you want to inactivate

  • Click on the ‘Set inactive’ button on the upper right-hand side of the page

  • Confirm your choice in the dialog that appears.

...

Archive an offer

You have the option to delete inactive offers from the Offers list by archiving itthem.

  • Go Navigate to the Offers management pagetab

  • Click on the ‘Edit’ button of the inactive offer you want to archive

  • Click on the ‘Archive’ button on the upper right-hand side of the page

  • Confirm your choice in the dialog that appears

Archivation is irreversible. Once an offer is archived, it cannot be restored anymore.

...

Search for an offer

Use the search bar to search for a specific offer’s name in the offer list on the Offer management Offers page.

...

Filter offers

Filter your offers on the Antavo Back Office Backoffice by clicking the ‘Filters’ button at the top of the module configuration page. There are three options: filter offers by type, status, or both. Just click ‘Apply’ to see the filtered list, or ‘Reset’ to choose a new filtering method.

...

...

Sorting of offers

You can define the order of offers on the membership site by navigating to the ‘Sorting’ option in the sidebar. The list of the offers returned by the Display API will be ordered based on the sorting set.
Just drag and drop the flow to change the order, and the changes are automatically applied.