Configuration Options

clientId

  • Type: string
  • Default: ''

Your unique Client ID

lang

  • Type: string
  • Default: "en"

The language in which the UI should be displayed

defaultPage

  • Type: string
  • Default: "/home"

The default page that should be displayed when opening online auctions page and the bidding app starts working. Available options:

  • /home
  • /auctions
  • /lots
  • /private-treaty/auctions
  • /private-treaty/lots
  • /favorite-auctions
  • /favorite-lots
  • /invoices
  • /settlements
  • /items
  • /temporary-items
  • /profile

loginUrl

  • Type: string
  • Default: ''

The URL to which the user will be redirected when clicking on login buttons/links

loginHandler

  • Type: function|null
  • Default: null

JavaScript function that will be executed when the login button is clicked. You must provide either loginUrl or loginHandler. If you provide both, both will work.

signupUrl

  • Type: string
  • Default: ''

The URL to which the user will be redirected when clicking on signup buttons/links

signupHandler

  • Type: function|null
  • Default: null

JavaScript function that will be executed when the signup button is clicked. You must provide either signupUrl or signupHandler. If you provide both, both will work.

  • Type: array
  • Default: []

Links displayed below the bidding section. Each link in this array must be an object containing the following properties:

  • text (Required) - The actual text of the link.
  • url (Optional) - URL to be opened.
  • target (Optional) - HTML "target" attribute: "_self", "_blank", etc...
  • handler (Optional) - JavaScript function that will be executed when the link is clicked.

translationsUrl

  • Type: string
  • Default: ''

The URL that must return translations in all languages. If you plan to have only English language, you can skip this or set it to an empty string.

translations

  • Type: object
  • Default: {}

Translations object

Example

<script>
window.artisioWebapp = {
    ...
    translations: {
        en: {
            'Register as bidder': 'Your custom translation'
        },
    }   
}
</script>

socialShares

  • Type: boolean
  • Default: false

Which social share icons to be displayed. This can be either a boolean or an array.

  • true - All supported social sharing buttons will be displayed.
  • false - None of the social sharing buttons will be displayed.
  • Array - Only those buttons will be displayed. Available social sharing buttons: 'email', 'facebook', 'twitter', 'linkedin'

printButton

  • Type: boolean
  • Default: false

Whether to show the print button or not. This can be either a boolean or a function.

  • true - The button will be displayed, and default printing behavior will happen.
  • false - The button will be hidden.
  • Function - The button will be displayed, and the specified function will be called.

jumpToLot

  • Type: boolean
  • Default: true

Whether to show the "Jump to lot" input or not

showBreadcrumbs

  • Type: boolean
  • Default: true

Whether to show breadcrumbs or not.

showPrevNextList

  • Type: boolean
  • Default: true

Whether to show "Previous", "Next," and "Back to list" buttons or not

showLatestBids

  • Type: boolean
  • Default: false

To show the latest 5 bids in lot view or not.

enableWatchlist

  • Type: boolean
  • Default: true

Whether to enable the "Add to watchlist" button or not

perPageSelect

  • Type: boolean
  • Default: true

Whether to show the select box for page size or not

enableAuth

  • Type: boolean
  • Default: true

Whether to show authentication buttons or not

enableBidding

  • Type: boolean
  • Default: true

Whether to enable bidding or not

enableFilters

  • Type: boolean
  • Default: true

Whether to enable sidebar filters or not

enableSorting

  • Type: boolean
  • Default: true

Whether to enable sorting options dropdown

showCountdown

  • Type: boolean
  • Default: true

Whether to show the countdown timer or not

descriptionInSidebar

  • Type: boolean
  • Default: false

Whether to show the description of lot in the sidebar or not. If you set it to false, it will be displayed below images

sharesInSidebar

  • Type: boolean
  • Default: false

Whether to move share and print buttons to the sidebar. If you set it to false, they will be displayed below images

visibleForGuestsSelector

  • Type: string
  • Default: '.ta-visible-for-guest'

CSS Selector. These elements will be visible when the user is a guest but hidden when the user is authorized

visibleForAuthSelector

  • Type: string
  • Default: '.ta-visible-for-auth'

CSS Selector. These elements will be visible when the user is authorized but hidden when the user is a guest

artisioCookieName

  • Type: string
  • Default: 'artisio_timed_sso'

Artisio SSO cookie name

enablePrivateTreaty

  • Type: boolean
  • Default: false

Whether to enable private treaty buttons like "Make an offer" and "Make an Enquiry"

makeAnEnquiryEmail

  • Type: string
  • Default: ''

The email address to be used for the "Make an Enquiry" button for "mailto"

branchUuid

  • Type: null
  • Default: null

Artisio branch UUID for which you want to display content on the website. If you leave this null, it will display content for all branches

showCollectionInfo

  • Type: boolean
  • Default: true

Whether to show collection information in lot listing and in the lot inner page

descriptionDynamicFields

  • Type: boolean|Array
  • Default: false

Dynamic fields to be rendered for lot description. Giving false here means that the item's actual description should be rendered. Giving true here means that all dynamic fields should be iterated and rendered. If it is an array, you should give Artisio dynamic field names that will be used to render fields

showMoreInDescription

  • Type: boolean
  • Default: false

Display "Show More" button when rendering the description

hideDepartmentsIfSelected

  • Type: boolean
  • Default: false

Hide the department list from filters sidebar if department is selected

alwaysShowCategories

  • Type: boolean
  • Default: false

Whether to always show categories or only show when a department is selected

templates

  • Type: object
  • Default: {...TEMPLATES}

Default templates for the webapp. For more information check Templates section

paginationType

  • Type: string
  • Default: 'PAGINATION'

The type of pagination to be used. Options: 'PAGINATION', 'LOAD_MORE', 'SCROLL'

lotDefaultSortField

  • Type: string
  • Default: 'lot_no'

The default sort field for lots. Any valid lot field is accepted. Ex: lot_no, end_date, start_date, visited

favoriteLotDefaultSortField

  • Type: string
  • Default: 'end_date'

The default sort field for favorite lots. Any valid lot field is accepted. Ex: lot_no, end_date, start_date, visited

lotDefaultSortBy

  • Type: string
  • Default: 'asc'

The default sort by for lots. Valid Options: 'asc', 'desc'

favoriteLotDefaultSortBy

  • Type: string
  • Default: 'asc'

The default sort by for favorite lots. Valid Options: 'asc', 'desc'

auctionDefaultSortField

  • Type: string
  • Default: 'end_date'

The default sort field for auctions. Any valid auction field is accepted. Ex: auction_no, end_date, start_date

favoriteAuctionDefaultSortField

  • Type: string
  • Default: 'end_date'

The default sort field for favorite auctions. Any valid auction field is accepted. Ex: auction_no, end_date, start_date

auctionDefaultSortBy

  • Type: string
  • Default: 'asc'

The default sort by for auctions. Valid Options: 'asc', 'desc'

favoriteAuctionDefaultSortBy

  • Type: string
  • Default: 'asc'

The default sort by for favorite auctions. Valid Options: 'asc', 'desc'

lotPaginationLimit

  • Type: number
  • Default: 25

Default limit for lot pagination. Options can be configured by the option perPageOptions. The maximum supported number is 100. Anything above 100 will be reset to 100

favoriteLotPaginationLimit

  • Type: number
  • Default: 25

Default limit for favorite lots pagination. Options can be configured by the option perPageOptions. The maximum supported number is 100. Anything above 100 will be reset to 100

auctionPaginationLimit

  • Type: number
  • Default: 25

Default limit for auction pagination. Options can be configured by the option perPageOptions. The maximum supported number is 100. Anything above 100 will be reset to 100

favoriteAuctionPaginationLimit

  • Type: number
  • Default: 25

Default limit for favorite auctions pagination. Options can be configured by the option perPageOptions. The maximum supported number is 100. Anything above 100 will be reset to 100

termsAndConditionsHtml

  • Type: boolean
  • Default: false

Terms and Conditions HTML string. If this option, "Terms and Conditions" content in sale edit dialog in Artisio AMS and termsAndConditionsUrl all are set to false, terms and conditions link will be hidden

termsAndConditionsUrl

  • Type: boolean
  • Default: false

Terms and Conditions URL. If this and termsAndConditionsHtml both are set to false, terms and conditions links will be hidden. If this and termsAndConditionsHtml both are set to a non-false value, this will have higher priority

termsAndConditionsVersion

  • Type: string
  • Default: ''

Terms and Conditions version.
This version will be used to detect if the current user has accepted latest version of terms and conditions or not. If not accepted, then user will receive a modal to accept terms and conditions before doing anything else on the website.

If this is set and one of the following values are provided:
termsAndConditionsUrl, termsAndConditionsHtml, then terms and conditions checkbox will be displayed during registration process and user will be forced to accept terms and conditions.
This requires the following component to be added to the signupInputsTemplate.

<terms-and-conditions />

Also, when user opens the webapp, if version is changed and user has not accepted the version, modal will be displayed forcing users to accept the new terms and conditions.

Note

Alongside with termsAndConditionsVersion, either termsAndConditionsUrl or termsAndConditionsHtml must be set to a non-empty value.
If both are provided with a non-empty value, termsAndConditionsHtml will have higher priority.

currencyFormat

  • Type: string
  • Default: '{symbol}{number:000,000.00}'

Currency formatting special string. {symbol} can be moved at the end of the formatting string or replaced with {code} to display the currency code instead of the symbol. Whitespace can be inserted between {symbol} and {number:} to have visual separation on the web app. In {number:}, "," acts as a thousands separator. Following options are supported for a thousand separator:

  • Dot - "."
  • Comma - ","
  • Apostrophe - "‘"
  • Space - " "

In {number:}, "." acts as a decimal separator. Following options are supported for a decimal separator:

  • Dot - "."
  • Comma - ","

Example:

  • "{symbol}{number:000 000,00}" - $100 000,99
  • "{symbol}{number:000,000.00}" - $100,000.99
  • "{symbol}{number:000000,00}" - $100000,99
  • "{symbol}{number:000'000,00}" - $100'000,99
  • "{code} {number:000 000,00}" - USD 100 000,99
  • "{number:000 000,00} {code}" - 100 000,99 USD
  • "{number:000 000,00}{code}" - 100 000,99USD
  • "{number:000 000.00} {code}" - 100 000.99 USD
  • "{number:000 000.00}{code}" - 100 000.99USD
  • "€{number:000 000,00}" - €100 000,99

dateFormat

  • Type: string
  • Default: 'DD MMM YYYY'

Default format for how dates should be displayed in the Web App

datetimeFormat

  • Type: string
  • Default: 'DD MMM YYYY HH:mm'

Default format for how datetimes should be displayed in the Web App

datetimeFormatWithSeconds

  • Type: string
  • Default: 'DD MMM YYYY HH:mm:ss'

Default format for how datetimes with seconds should be displayed

timeFormat

  • Type: string
  • Default: 'HH:mm'

Default format for how time should be displayed in the Web App

timeWithSecondsFormat

  • Type: string
  • Default: 'HH:mm:ss'

Default format for how time with seconds should be displayed in the Web App

autoApplyFilters

  • Type: boolean
  • Default: true

When you change something in the filters section, whether it should auto apply filters or not. If this is set to false, the "Apply Filters" button will be visible

fullScreenButtonOnImage

  • Type: boolean
  • Default: false

Whether to show full screen button on image

dontOpenOnImageClick

  • Type: boolean
  • Default: false

You can disable opening image on full screen by clicking on the image, instead you can use fullScreenButtonOnImage option to give users possibility to expand the image on full screen

backButtonOnImage

  • Type: boolean
  • Default: false

Whether to show back to list button on image

enableNotifyMeOnLotStart

  • Type: boolean
  • Default: false

Whether to enable the "Notify Me" on Lot Start button or not

homeUrl

  • Type: null
  • Default: null

The home page URL of the application. If you leave this null, it will use the Webapp's default home page address

gtag

  • Type: object
  • Default: { config: { id: null } }

Google tag manager configuration options for Vue Gtag package

All supported events

Event NameCategoryDescription
filters_clearauctionsWhen filters are cleared (reset)
filters_changeauctionsWhen filters are changed
perpage_changeauctionsWhen per page dropdown value is changed
sorting_changeauctionsWhen sorting is changed
set_grid_viewauctionsWhen auction listing view switches from list view to grid view
auction_viewauctionsWhen auction is opened
filters_changelotsWhen filters are changed
perpage_changelotsWhen per page dropdown value is changed
sorting_changelotsWhen sorting is changed
set_view_typelotsWhen lot listing view switches from list view to grid view
click_prevlotsWhen previous lot link is clicked
click_nextlotsWhen next lot link is clicked
click_back_to_listlotsWhen "Back to list" link is clicked
lot_viewlotsWhen lot is opened
add_to_watchlistlotsWhen item is added into watchlist
remove_from_watchlistlotsWhen item is removed from watchlist
click_place_bidlotsWhen place a bid button is clicked
click_buy_nowlotsWhen buy now button is clicked
click_place_bid_yeslotsWhen "Yes" button is clicked during place a bid confirmation
click_place_bid_nolotsWhen "No" button is clicked during place a bid confirmation
click_place_bid_closelotsWhen "X" button is clicked during place a bid confirmation
mouse_enter_place_bidlotsWhen mouse enter event happens on place a bid button
mouse_leave_place_bidlotsWhen mouse leave event happens on place a bid button
click_set_max_bid_clicklotsWhen set max bid button is clicked
set_max_bidlotsWhen max bid is set
delete_max_bidlotsWhen max bid is deleted
close_max_bidlotsWhen max bid modal is closed
view_bid_historylotsWhen view bid history button is clicked
image_full_screenlotsWhen image goes on full screen
register_as_bidder_clicklotsWhen register as bidder button is clicked
register_as_bidder_dialog_nolotsWhen "No" button is clicked in the register as bidder dialog
register_as_bidder_dialog_yeslotsWhen "Yes" button is clicked in the register as bidder dialog

filterLotStatusOptions

  • Type: array
  • Default: ['all', 'published', 'sold', 'unsold']

Available options to be displayed under "Lot Status" filter criteria for filtering lots. All available options are:

  • all - Will display all lots
  • published - Will display only lots that are published
  • sold - Will display only sold lots
  • unsold - Will display only unsold lots

defaultLotStatus

  • Type: string
  • Default: 'published'

Default lot status selected in "Lot Status" filter criteria for filtering lots

perPageOptions

  • Type: array
  • Default: [5, 10, 25, 50, 100]

Per page dropdown options that will be displayed in every per page dropdown. The maximum supported value is 100. Any value above 100 will be removed from this list and not be displayed

showBiddingLimit

  • Type: boolean
  • Default: true

Whether to show the bidding limit for bidders or not. Please consider that this only makes sense if bidding limits are configured and set for bidders. Even if you set this true, but no bidding limits are configured, nothing will be displayed

personalIdentificationDetails

  • Type: boolean
  • Default: false

Whether to display personal identification fields in registration or not

bankAccountDetails

  • Type: boolean
  • Default: false

Whether to display bank account fields in registration or not

showReserveStatus

  • Type: boolean
  • Default: true

Whether to show the current reserve status or not

liveBiddingButtonShowTime

  • Type: number
  • Default: 15

Number of minutes before the live auction start date to display the live auction bidding button

liveCommissionButtonHideTime

  • Type: number
  • Default: 15

Number of minutes before the live auction start date to hide commission bid buttons

showAuctionType

  • Type: boolean
  • Default: false

Whether to show the auction type in auction listing or in auction inner page

showBidAmountsInConfirmation

  • Type: boolean
  • Default: false

Setting true here will display 3 main numbers in confirmation dialog when user tries to make a bid.

  • Bid Amount
  • Commission (Calculated based on premiums)
  • Total Amount (Bid Amount + Commission)

overlayFilters

  • Type: boolean
  • Default: false

By default filters are displayed staticly on the place where it is configured. If you set this true, only filters button will be displayed and clicking on it will show filters overlay over content

imageCarouselPosition

  • Type: string
  • Default: 'bottom'

Image thumbnail carousel position on lot view page. Possible options: 'left', 'bottom'

showZeroLotCount

  • Type: boolean
  • Default: true

Whether to show lots count when the value is 0 in auctions list.

showAuctionBiddingOpenBadge

  • Type: boolean
  • Default: true

Whether to show 'bidding is open' badge for auction in auctions list

enableBuyNowOnPublishedAuction

  • Type: boolean
  • Default: false

Whether to show Buy Now button and enable Buy now functionality on published auctions when bidding is in progress. Warning! This will not show buy now button on live auctions.

alwaysSelectFirstDepartment

  • Type: boolean
  • Default: false

Activating this option is a good idea only for those auction houses who have only a single department

inquiryTimeAnchor

  • Type: number
  • Default: null

An option that determines how many minutes before the lot closes the phone number will be displayed when sending an inquiry

groupLotsOnMyBidsPage

  • Type: boolean
  • Default: false

Whether to group lots by auction on my bids page

groupLotsOnFavouritesPage

  • Type: boolean
  • Default: false

Whether to group lots by auction on my bids page

allowBidderAutoRegistration

  • Type: boolean
  • Default: true

If this is set to true and if auction was not marked otherwise, bidder will be registered automatically when opening the lot inner view. If this is set to false then "Register as bidder" button will become visible and bidder will not be automatically registered on the sale.

This setting losses the purpose if one of the following fields was checked on auction from Artisio AMS:

  • "Require Bidder Approval"
  • "Request Deposit"
  • "Require Credit Card Verification"

scrollToTopOnPageChange

  • Type: boolean
  • Default: true

To scroll at the top of the lot/auction listing when page changes with pagination buttons

googleMapsLoadConfig

  • Type: object
  • Default: {key: ''}

Google Maps Load configuration object. Available configuration options can be found here

veeValidateMessages

  • Type: object
  • Default: {}

Vee Validate package validation messages. The object needs to be in the following format. You can only provide and customize the message you need to be customized, others will be taken with their default values...

{
  "alpha": "The {_field_} field may only contain alphabetic characters",
  "alpha_num": "The {_field_} field may only contain alpha-numeric characters",
  "alpha_dash": "The {_field_} field may contain alpha-numeric characters as well as dashes and underscores",
  "alpha_spaces": "The {_field_} field may only contain alphabetic characters as well as spaces",
  "between": "The {_field_} field must be between {min} and {max}",
  "confirmed": "The {_field_} field confirmation does not match",
  "digits": "The {_field_} field must be numeric and exactly contain {length} digits",
  "dimensions": "The {_field_} field must be {width} pixels by {height} pixels",
  "email": "The {_field_} field must be a valid email",
  "excluded": "The {_field_} field is not a valid value",
  "ext": "The {_field_} field is not a valid file",
  "image": "The {_field_} field must be an image",
  "integer": "The {_field_} field must be an integer",
  "length": "The {_field_} field must be {length} long",
  "max_value": "The {_field_} field must be {max} or less",
  "max": "The {_field_} field may not be greater than {length} characters",
  "mimes": "The {_field_} field must have a valid file type",
  "min_value": "The {_field_} field must be {min} or more",
  "min": "{_field_} German {length}",
  "numeric": "The {_field_} field may only contain numeric characters",
  "oneOf": "The {_field_} field is not a valid value",
  "regex": "The {_field_} field format is invalid",
  "required_if": "The {_field_} field is required",
  "required": "The {_field_} field is required",
  "size": "The {_field_} field size must be less than {size}KB",
  "double": "The {_field_} field must be a valid decimal"
}

countdownDurationTranslations

  • Type: object
  • Default: {}

Countdown duration translations. Where the key is the language code and the value is object containing one of the available duration characters: d, h, m, s

The default values:

  • d - days
  • h - hours
  • m - minutes
  • s - seconds

Example: This will only override d and use j instead of d in fr language code.

window.artisioWebapp = {
  countdownDurationTranslations: {
    fr: {
      "d": "j"
    }
  }
}
Last Updated:
Contributors: Zura Sekhniashvili