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
Please find attached an example of a successful Post body.
The following data must be sent to bidlogix to create an auction with a value as indicated in the table below:
Name | Type | Value Range | Required | Default |
|---|---|---|---|---|
| type | String | 'timed' or 'webcast'. NB market place auctions cannot be created via the api. | Y | - |
| @class | String | com.bidlogix.scaffold.models.auctionapi.AuctionApiModel | Y | - |
All other parameters must be sent although only some are actually saved and all other parameter values will be ignored and values will be defaulted (e.g. autionStartTime will be defaulted to the date and time that the call is made). Parameters marked as "saved" in the table below will have the value from the API saved and anything marked as "defaulted" will be overwritten by the default value from the system.
These 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 | Saved or Defaulted? |
|---|---|---|---|
id | Long | a unique identifier within the bidlogix system - sent back by bidlogix to the caller for foreign key storage | defaulted to system assigned value |
| title | String | The title or name of the auction. | saved |
| description | String | A description of the auction. | defaulted to blank |
| auctioneer | AuctioneerApiModel | The auctioneer identified by the query string parameter 'auctioneerId' - must exist within bidlogix system. | defaulted dependant on value in call |
Defaults for item charges applicable in this auction. | |||
| salesTaxRequired | boolean | whether to apply sales tax | defaulted to true |
| buyersPremiumRequired | boolean | whether to apply buyers premium | defaulted to true |
| buyersPremium | BigDec | rate at which to apply buyers premium | defaulted to value from auctioneer |
| bpTaxRate | BigDec | rate at which to apply tax on buyers premium | saved |
| chargesTaxRate | BigDec | rate at which to apply charges | saved |
| hammerTaxRate | BigDec | rate at which to apply tax on the hammer price | saved |
| defaultDeposit | Long | If a user is required to pay a deposits (in auction registration) then this will be the default amount. | defaulted to auctioneer default |
auctionCreditCardLocation | CountryModel | See Common Data document applicable if credit card validation is turned on. | defaulted to auctioneer default |
featured | Boolean | sets this auction to be featured - i.e. to display before other auctions in calendar / home pages. | defaulted to false |
logo | UrlAttachmentApiModel | See Common Data document | defaulted to none |
| documents | List<UrlAttachmentApiModel> | See Common Data document | defaulted to none |
| location | AddressModel | See Common Data document | Saved or defaulted to empty address. |
| country | Saved | ||
| currency | Saved | ||
| auctionCloses | Date 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. | saved |
| auctionStarts | Date time | Timed Auctions: Date and time the auction starts. Webcast Auctions: The time pre-bidding ends and the live auction begins. | defaults to the time/date the call is made |
| clearanceComment | String | Notes on clearance of items | default |
| clearanceStartDate | Date time | Start of collection of goods | default |
| clearanceEndDate | Date time | End of collection of goods | default |
| viewingComment | String | Comments on viewing. | default |
| viewByAppointment | String | Whether an appointment is required and if so the details | default |
| viewingStartDate | Date time | Start of viewing | default |
| viewingEndDate | Date time | End of viewing | default |
| Timed Auctions Only | |||
| staggerEndTimes | Boolean | Toggles the stagger end time feature | default to off |
| endTimeIncrementInMins | Integer | The time intervals set for the closing of items / groups of items | default |
| endTimeIncrementStepSizeInLots | Integer | The size of the groups of items set to close at the same time. | default |
| buyNowCutoff | Integer | 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. | default to 2 days |
| extension | Integer | number 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. | default to 600 seconds |
Key
See Status Codes document.