Qixol Promo Help > Promo Core

 

Settings

 

 

 

 

Settings are managed at either the company or user levels:

 

oCompany settings are either company wide configuration or settings that relate to the whole company, and can only be updated by organisation or company administrators (see Users)

 

oUser settings are settings that are specific to the current user, and typically only deal with display options.

 

 

Settings can be managed within a company by navigating to Settings under Configuration.

 

 

Setting Name

 

Category

Level

Default Value

Description

Backup Data Format

Backups

Company

XML

Default format for backups, select from: Json or XML.

Available where the  Promo Backups Module  is configured for a company.

 

Backup FTP Failure Notification Email

Backups

Company

 

Email address to contact when a backup FTP upload fails.

Available where the  Promo Backups Module  is configured for a company.

 

Backup FTP Password

Backups

Company

 

Password to be used when uploading a backup to FTP.

Available where the  Promo Backups Module  is configured for a company.

 

Backup FTP Server Url

Backups

Company

 

The URL for the FTP site to upload a backup to.

Available where the  Promo Backups Module  is configured for a company.

 

Backup FTP Upload Enabled

Backups

Company

False

Flag indicating whether uploading to FTP is available.

Available where the  Promo Backups Module  is configured for a company.

 

Backup FTP Username

Backups

Company

 

The user name to be used when uploading a backup to FTP.

Available where the  Promo Backups Module  is configured for a company.

 

Allow Editing of In-Use Promotions?

General

Company

False

Flag indicating whether in-use promotions can be edited.

This option is available upon request - please contact Qixol Support for assistance.

 

Allow Reviewing of Saved Baskets

General

Company

False

Indicates whether to show the History section in the navigation area, to allow the user to view recently submitted baskets.

 

Default Currency Code

General

Company

GBP

The default currency code for the company, based upon the available attribute values for the Currency system attribute.

 

Permit layering promotions outside Best Deal

General

Company

False

Flag indicating whether promotion layering is enabled.  When enabled, this allows promotions to be configured outside of the Best Deal calculations. 

 

Persist Product History

General

Company

False

Flag indicating whether product changes should create a historic version of the product - to support revalidation of historic baskets and ensure the same product configuration is used.

 

Persisted Historic Product Expiration (days)

General

Company

60

The number of days to persist historic product changes.

 

Webhook Disabled Notification Email

General

Company

 

The email to use when a webhook delivery fails.

 

Webhook Payload Data Type

General

Company

XML

The payload data type for webhook messages.  JSON or XML.

 

Api Services - Enable Gift Card Activate

Gift Cards

Company

False

Available where the  Promo Gift Cards Module  is configured for a company.

Flag indicating whether the Gift Card API Activate (80500) method is available (see API schemas and samples).

 

Api Services - Enable Gift Card Add and Delete

Gift Cards

Company

False

Available where the  Promo Gift Cards Module  is configured for a company.

Flag indicating whether the Gift Card API Add and Delete (80300, 80400) methods are available (see API schemas and samples).

 

Api Services - Enable Gift Card Import and Generate

Gift Cards

Company

False

Available where the  Promo Gift Cards Module  is configured for a company.

Flag indicating whether the Gift Card API Import and Generate (20810, 20800) methods are available (see API schemas and samples).

 

Api Services - Enable Gift Card Number, Group and Transaction List

Gift Cards

Company

False

Available where the  Promo Gift Cards Module  is configured for a company.

Flag indicating whether the GiftCard API List (80100, 80200, 80900) methods are available (see API schemas and samples).

 

Api Services - Enable Gift Card Withdraw and Adjust Balance

Gift Cards

Company

False

Available where the  Promo Gift Cards Module  is configured for a company.

Flag indicating whether the GiftCard API Withdraw and Adjust Balance (80600, 80700) methods are available (see API schemas and samples).

 

Default gift card balance for Basket Builder

Gift Cards

Company

20

Available where the  Promo Gift Cards Module  is configured for a company.

The default balance amount for card numbers to be activated.

 

Pending Card Number Lock Release Time

Gift Cards

Company

10

Available where the  Promo Gift Cards Module  is configured for a company.

The release time in minutes for Gift Card number locks.

 

Require reporting code for balance adjustments

Gift Cards

Company

True

Available where the  Promo Gift Cards Module  is configured for a company.

Flag indicating whether a reporting code is required for adjustment actions.

 

Require reporting code for redemptions

Gift Cards

Company

True

Available where the  Promo Gift Cards Module  is configured for a company.

Flag indicating whether a reporting code is required for redemption actions.

 

Require reporting code for withdrawals

Gift Cards

Company

True

Available where the  Promo Gift Cards Module  is configured for a company.

Flag indicating whether a reporting code is required for withdrawal actions.

 

Allow Currency Add, Edit and Delete in Portal

Integration

Company

True

Flag indicating whether the currency code values can be maintained in the Portal.  For integration scenarios it may be desirable to only manage the values via API integration actions.

 

Allow Currency Import in Portal

Integration

Company

True

Flag indicating whether the currency code values can be imported in the Portal.  For integration scenarios it may be desirable to only manage the values via API integration actions.

 

Allow Customer Group Add, Edit and Delete in Portal

Integration

Company

True

Flag indicating whether the customer group values can be maintained in the Portal.  For integration scenarios it may be desirable to only manage the values via API integration actions.

 

Allow Customer Group Import in Portal

Integration

Company

True

Flag indicating whether the customer group values can be imported in the Portal.  For integration scenarios it may be desirable to only manage the values via API integration actions.

 

Allow Delivery Method Add, Edit and Delete in Portal

Integration

Company

True

Flag indicating whether the delivery method values can be maintained in the Portal.  For integration scenarios it may be desirable to only manage the values via API integration actions.

 

Allow Delivery Method Import in Portal

Integration

Company

True

Flag indicating whether the delivery method values can be imported in the Portal.  For integration scenarios it may be desirable to only manage the values via API integration actions.

 

Allow Product Add, Edit and Delete in Portal

Integration

Company

True

Flag indicating whether products can be maintained in the Portal.  For integration scenarios it may be desirable to only manage the values via API integration actions.

 

Allow Product Import in Portal

Integration

Company

True

Flag indicating whether products can be imported in the Portal.  For integration scenarios it may be desirable to only manage the values via API integration actions.

 

Enable Promotion Group Maintenance Operations via Services

Integration

Company

False

Available where the  Promo Configuration Services Module  is configured for a company.

Flag indicating whether the Configuration Services API for Promotion Group maintenance (40220, 40230, 40240) methods are available (see API schemas and samples).

 

Enable Promotion Lock/Unlock via Services

Integration

Company

False

Available where the  Promo Configuration Services Module  is configured for a company.

Flag indicating whether the Configuration Services API for Locking/Unlocking Promotions (40160) is available (see API schemas and samples).

 

Enable Promotion Maintenance Operations via Services

Integration

Company

False

Available where the  Promo Configuration Services Module  is configured for a company.

Flag indicating whether the Configuration Services API for Promotion maintenance (40120, 40130, 40140) methods are available (see API schemas and samples).

 

Enable Promotion Publish via Services

Integration

Company

False

Available where the  Promo Configuration Services Module  is configured for a company.

Flag indicating whether the Configuration Services API for Publishing Promotions (40150) is available (see API schemas and samples).

 

Enable Reporting Code Maintenance Operations via Services

Integration

Company

False

Available where the  Promo Configuration Services Module  is configured for a company.

Flag indicating whether the Configuration Services API for Reporting Code maintenance (40320, 40330, 40340) methods are available (see API schemas and samples).

 

Default Points Redemption Profile

Loyalty

Company

Pooled

Available where the  Promo Loyalty Module  is configured for a company.

The default value for Default Points Redemption Profile when creating a new scheme.

 

Show All Contact Details

Loyalty

Company

False

Available where the  Promo Loyalty Module  is configured for a company.

Flag indicating whether the contact details (first name, surname and email) should be shown to users.  Also dependant upon the user's role configuration.

 

Add current user as Promotion Watcher for new promotions

Notifications

Company

True

Flag indicating that for new promotions the current user will automatically be added as a notification watcher.

 

Maximum basket discount notifications in period

Notifications

Company

5

The maximum number of basket type notifications that can be reported within a period.

 

Maximum basket discount notifications period

Notifications

Company

2

The reporting period for basket notifications, in hours.

 

New Line Level Promotion Default Basket Discount Value

Notifications

Company

50

The default value for Exceeds percentage of basket total value or Exceeds value, under Notify Promotion Watchers where discount applied by this promotion to any confirmed basket when creating a new promotion.

 

New Line Level Promotion Default Basket Discount Warning

Notifications

Company

0

Option indicating whether the value for New Line Level Promotion Default Basket Discount Value applies to Exceeds percentage of basket total value or Exceeds value.

 

Notify on Published Promotion Change (default)

Notifications

Company

True

Flag indicating whether to default the setting to notify the watchers when a promotion changes.

 

Company Display Highlight

Portal

Company

grey

The highlight colour for the company.

 

Company Display Name

Portal

Company

 

The display name of the company.  Shown above the Navigation area in the Portal.

 

Default Delivery Charge

Portal

Company

5.99

The default delivery charge for the basket builder.

 

Default voucher codes to Issued when generating?

Portal

Company

True

Flag indicating whether the Issue Now? flag is ticked by default when generating voucher codes.

 

Show Overridable Attributes in Basket Builder

Portal

Company

True

Flag indicating whether to show product attributes in the Basket Builder, where attributes are configured with the Use value provided with basket lines? setting.

 

Confirm Code Use from Basket Builder

Promotion Engine

Company

False

Flag indicating whether the Confirm Basket? option is available in the basket builder.

 

Coupon Code Lock Release Time (minutes)

Promotion Engine

Company

10

The release time in minutes for coupon code locks.

 

Coupon Code Locks Enabled

Promotion Engine

Company

False

Flag indicating whether to lock coupon codes when they are utilized by unconfirmed baskets.

 

Engine provides best/worst value

Promotion Engine

Company

Best Deal

Flag indicating whether to calculate the best deal or the worst deal for customers.  Select from Best Deal or Worst Deal.

 

Missing currency value handling

Promotion Engine

Company

Use default currency value

Define how promotions which provide a value discount are handled, where a value has not been supplied for the currency of the basket.  Select from Use default currency value or Do not apply the promotion.

 

Require baskets to be confirmed

Promotion Engine

Company

False

Flag indicating whether baskets submitted from the API services need to provide the Confirmed flag before coupon utilization is confirmed.  For web channels this would typically be true, for a till system where abandoned baskets are uncommon, this would be false.

 

Format for displaying date

Portal

User

dd/MM/yyyy HH:mm:ss

The date format to use when displaying dates.  Select from   dd/MM/yyyy HH:mm:ss, MM/dd/yyyy HH:mm:ss, yyyy/MM/dd HH:mm:ss

 

Query before saving promotions with conflicts

Portal

User

True

Flag indicating whether to check for conflicts before saving a promotion, and where conflicts are found to notify the current user.

 

Show Back Buttons

Portal

User

False

Flag indicating whether to show back buttons throughout.  By default back buttons are only shown on pages that are selected from a list or are the result of an action.

 

Show Developer Tools

Portal

User

False

Flag indicating whether to show developer tools.  Developer tools allow the View Xml and View Json toolbar actions to be displayed.

 

Show Navigation Location (Breadcrumbs)

Portal

User

True

Flag indicating whether to show breadcrumbs at the top of pages.

 

Show Product Images

Portal

User

True

Flag indicating whether to show the product images in the products list and products browser.

 

Start Page

Portal

User

Configuration

The page to show when the user opens the company.

Select from Configuration, Promotions, Basket Builder, Dashboard

 

 

 

 

 

Copyright © 2021 Qixol Ltd.