Individual auctions can be retrieved by using the following URL along with the auction ID.
| Method | URL |
| GET | https://api.fairwarningsoftware.com/v1.1.1/auction/[id] |
| Status | Response |
| 200 | { "auction_id": <auction_id>, "company_id": <company_id>, "auction_lock": <auction_lock>, "auction_hide": <auction_hide>, "auction_preview": <auction_preview>, "auction_event": <auction_event>, "type_id": <type_id>, "type_name": <type_name>, "office_id": <office_id>, "office_name": <office_name>, "department_id": <department_id>, "department_name": <department_name>, "auction_date": <auction_date>, "auction_name": <auction_name>, "auction_slug": <auction_slug>, "auction_bidder_type_ids": <auction_bidder_type_ids>, "bidsquare_ids": <bidsquare_ids>, "auction_description": <auction_description>, "auction_comments": <auction_comments>, "auction_terms": <auction_terms>, "auction_event_description": <auction_event_description>, "external_bidding_id": <external_bidding_id>, "external_bidding_url": <external_bidding_url>, "external_bidding_logo": <external_bidding_logo>, "system_type_id" : <system_type_id>, "system_type_name" : <system_type_name>, "past_auction" : <past_auction>, "item_count" : <item_count>, "primary_image": { "base" : [url-base], "parts" : { "large" : [url-addition], "medium" : [url-addition], "small" : [url-addition] } }, "event_image": { "base" : [url-base], "parts" : { "large" : [url-addition], "medium" : [url-addition], "small" : [url-addition] } }, "auction_current_item>, "allows_phone_bids": <allows_phone_bids>, "exhibitions": [ { "exhibition" : { "exhibition_id" : [exhibition-id], "auction_id" : [auction-id], "exhibition_start" : [exhibition-start], "exhibition_end" : [exhibition-end] } }, { "exhibition" : { "exhibition_id" : [exhibition-id], "auction_id" : [auction-id], "exhibition_start" : [exhibition-start], "exhibition_end" : [exhibition-end] } } ], "external_bidding_websites": [ { "external_site" : { "external_url" : [external_url], "external_logo" : [external_logo] } } ] } |
| 401 | {"error":"The API keys provided are invalid."} |
| 403 | {"error":"API keys are missing."} |
| 500 | {"error": <custom error>} |
| Field | Type | Description |
| auction_id | int | The unique identifier for the auction |
| company_id | int | The ID for your company |
| auction_lock | bool | Whether the auction is locked or not |
| auction_hide | bool | Whether the auction is hidden or not |
| auction_preview | bool | Whether the auction can be previewed or not |
| auction_event | bool | Whether the auction is an event or not |
| type_id | int | The ID for the type of auction it is |
| type_name | string | The name for the type of auction it is |
| office_id | int | The ID for the office set for the auction |
| office_name | int | The name for the office set for the auction |
| department_id | int | The ID for the department set for the auction |
| department_name | int | The name for the department set for the auction |
| auction_date | datetime | The date and time of the auction |
| auction_name | string | The name of the auction |
| auction_slug | string | The slug for the auction, with a possible multi-day ID on the end |
| auction_bidder_type_ids | string | A JSON formatted string containing the different bidder types that can bid in this auction |
| bidsquare_ids | string | A JSON formatted string containing the different Bidsquare catalog IDS and lot ranges for each catalog |
| auction_description | string | The description provided for the auction |
| auction_comments | string | Additional comments provided for the auction |
| auction_terms | string | The terms and conditions for the auction |
| auction_event_description | string | The description for the auction event |
| external_bidding_id | int | The ID of the system entry for the external website selected. |
| external_bidding_url | string | The external website URL to the catalog associated with this auction. |
| external_bidding_logo | string | The logo for the external website selected. |
| system_type_id | int | The system type ID associated with this auction |
| system_type_name | string | The system type name associated with this auction |
| past_auction | bool | Whether the auction is a past auction or not. |
| item_count | int | The number of items associated with this auction |
| primary_image | object | An object containing the base and paths to the different image sizes of the primary image |
| base | string | The base will contain the first part of the URL needed to retrieve the specified image. |
| parts | object | This will contain an array of URL parts for the different sizes of images. |
| large | string | The end of the URL to retrieve a large-sized image. |
| medium | string | The end of the URL to retrieve a medium-sized image. |
| small | string | The end of the URL to retrieve a small-sized image. |
| event_image | string | An object containing the base and paths to the different image sizes of the primary image |
| base | string | The base will contain the first part of the URL needed to retrieve the specified image. |
| parts | object | This will contain an array of URL parts for the different sizes of images. |
| large | string | The end of the URL to retrieve a large-sized image. |
| medium | string | The end of the URL to retrieve a medium-sized image. |
| small | string | The end of the URL to retrieve a small-sized image. |
| auction_current_item | string | The current item the auctioneer is on during a live auction. |
| allows_phone_bids | bool | Whether the auction allows phone bids to be taken. |
| exhibitions | object | This will contain an array of exhibition times if any were set for the auction. |
| exhibition | object | This will contain the data for one exhibition. |
| exhibition_id | int | The ID of the particular exhibition. |
| auction_id | int | The ID for the auction. |
| exhibition_start | date-time | The starting date and time of the exhibition. |
| exhibition_end | date-time | The ending date and time of the exhibition. |
| external_bidding_websites | string | An object containing the list of selected external websites to be used for live bidding |
| external_site | object | This will contain an array of URL's and images. |
| external_url | string | The URL to be used to link to the external bidding website. |
| external_logo | string | The logo to be used to link to the external bidding website. |
Below is a list of system auction types.
| System Type ID |
System Type Name |
| 1 | Live Auction |
| 2 | Timed Auction |
| 3 | Buy-It-Now Auction |
| 4 | Buy-It-Now with Timed Auction |
| 5 | Continuous Buy-It-Now Auction |
| 10 | Other |
You may additionally request a list of the advertised items for an auction by passing the flag `get_advertised` such as below:
{ "get_advertised" : 1 }
This will return an item array inside of an "advertised_items" tag.
Additionally, you may pass the user ID in the request. User bid registration data will be returned inline with the auction object.
| Response |
|
{ "user" : { |
| Field | Type | Description |
| user | object | Contains an object of user details. |
| bid_requirements | array object | Contains an array of requirement objects if bid requirements have not been met. |
| requirement_code | int | A numeric code corresponding to the requirement error. |
| requirement_message | string | An error message which can be displayed to the user. |
| Requirement Code |
Description |
| 1 | The user must submit a bid request, and has not yet submitted one. |
| 2 | The user submitted a bid request, but it is currently awaiting review. |
| 3 | The user submitted a bid request, but the request was denied. |
| 4 | The user must have their phone number, billing address, and shipping address on file. |
| 5 | The user must have a valid credit card on file. |