Description

Create an auction within the bidlogix system. 


URL

where

https://your_bidlogix_domain/auction-mgt/bdxapi/auction/{auctioneerId}?clientId=your_bidlogix_client_id
{auctioneerId} : the id of the auctioneer you wish to create an auction within - must exist within bidlogix. 

Method

Http Method: POST


Security

See API Security - Generating your Signature


Query String Parameters

See General API Information


Post Data

The minimum data that needs to be sent to bidlogix to create an auction is type and a class identifier for internal bidlogix use.

Name

Type

Value Range

Required

Default

typeString'timed' or 'webcast'. NB market place auctions cannot be created via the api.Y-
@classString
com.bidlogix.scaffold.models.auctionapi.AuctionApiModel
Y-

All other fields will be given default values.


Additional parameters are as follows. Note that any values sent 'out of bounds' (e.g. buyers premium > 100%) or otherwise broken will be overridden by default values.

Name

Type

Business Rules

Default

id

Longa unique identifier within the bidlogix system - sent back by bidlogix to the caller for foreign key storageGenerated
titleStringThe title or name of the auction.New Action + Timestamp
descriptionStringA description of the auction.-
auctioneer

AuctioneerApiModel

The auctioneer identified by the query string parameter 'auctioneerId' - must exist within bidlogix system.-


Defaults for item charges applicable in this auction.

salesTaxRequired

boolean

whether to apply sales tax

true

buyersPremiumRequiredbooleanwhether to apply buyers premium

true

buyersPremiumBigDecrate at which to apply buyers premiumfrom auctioneer
bpTaxRateBigDecrate at which to apply tax on buyers premium0%
chargesTaxRateBigDecrate at which to apply charges0%
hammerTaxRateBigDecrate at which to apply tax on the hammer price0%

defaultDepositLongIf a user is required to pay a deposits (in auction registration) then this will be the default amount.1000

auctionCreditCardLocation

CountryModelSee Common Data document applicable if credit card validation is turned on.none

featured

Booleansets this auction to be featured - i.e. to display before other auctions in calendar / home pages.false

logo

UrlAttachmentApiModelSee Common Data document
none
documentsList<UrlAttachmentApiModel>See Common Data document
none (from auctioneer)
locationAddressModelSee Common Data document
Empty address.

auctionClosesDate time

Timed Auctions: Date and time the auction closes - items will be created with this date & time as their end time if not overridden. Timed auctions are not displayed on the home/calendar pages after this date.

Webcast Auctions: No relevance except that webcast auctions are not displayed on the home/calendar pages after this date.


auctionStartsDate time

Timed Auctions: Date and time the auction starts.

Webcast Auctions: The time pre-bidding ends and the live auction begins.


clearanceCommentStringNotes on clearance of items
clearanceStartDateDate timeStart of collection of goods
clearanceEndDateDate timeEnd of collection of goods
viewingCommentStringComments on viewing.
viewByAppointmentStringWhether an appointment is required and if so the details
viewingStartDateDate timeStart of viewing
viewingEndDateDate timeEnd of viewing

Timed Auctions Only
staggerEndTimesBooleanToggles the stagger end time feature
endTimeIncrementInMinsIntegerThe time intervals set for the closing of items / groups of items
endTimeIncrementStepSizeInLotsIntegerThe size of the groups of items set to close at the same time.
buyNowCutoffInteger

Measured in days. Applies to item type 'Lots' only.

If either 'buy now' or 'make offer' features are switched on for a given lot then the feature will automatically switch off this number of days before the lot end time. The value defaults to 2 days and so any lot with buy now or make offer enabled will have the feature disabled 2 days before the end time.

2 days
extensionIntegernumber of seconds before the end time of the lot that, if a bid is placed during this time frame, overtime bidding (time extension) will be triggered.

600 seconds


Key

See Status Codes document.