Call: Auction Reports : Bidlogix

Description

The Auction Reports call reports bidding within a specific auction. The report shows item information including the winning bidders (winner) and under bidders (losers), item ID, category, lot number, item title, etc. It uses Http Method: GET.

The API must be structured correctly and have the correct security in place. See also Common API Errors.

See Status Codes and Common Data for more information on results.

URL

https://your_bidlogix_domain/auction-mgt/bdxapi/reporting/auction/{auctionId}/{sorting}?clientId=your_bidlogix_client_id

Key and Adaptations

{auctionId} : the id of the auction.

{sorting} : the field to sort the result by - only value currently supported is 'category'.

Appending the query string parameter: &includeImages=true to the end of the request, will result in a response that includes URLs to the images of the items.

Method

Http Method: GET

Security

See Bidlogix API

Query String Parameters

See Query String Parameters.

Success Response

For example:

{

"@class":".DataPushPayload",

"pushCode":"REPORTING_AUCTION",

"models":{

"auctionReport":{

"@class":".reporting.AuctionReportModel",

"reportMeta":{

"@class":".ReportMetaModel",

"reportType":1,

"reportObject":"AuctionReportModel",

"reportMade":1487937695748

},

"reportTitle":"Auction Report",

"webAppId":1,

"auctionId":4,

"auctionTitle":"Acme Live 3",

"auctionDescription":"Machinery formerly used by Machine Eng. Services Ltd Metal Metallurgising. Including CNC Press Brake, NC Turret Punch Press, Steelworker, Welding, Band Saws, Radial Drills",

"items":[

{

"@class":".ItemReportModel",

"category":{

"@class":".CategoryModel",

"id":9,

"name":"Centre Lathes - Manual - Straight & Gap Bed",

"code":null,

"selected":false,

"treeName":"Industrial Machinery",

"treeId":1,

"parentName":"Turning",

"parentId":1,

"children":null

},

"id":18,

"title":"Machine Lot 37",

"lotNumber":"7",

"imageUrls":[

"https://res.cloudinary.com/bidlogix-test/image/upload/v1/local_test_data/3.jpg",

"https://res.cloudinary.com/bidlogix-test/image/upload/v1/local_test_data/3-1.jpg",

"https://res.cloudinary.com/bidlogix-test/image/upload/v1/local_test_data/3-2.jpg",

"https://res.cloudinary.com/bidlogix-test/image/upload/v1/local_test_data/3-3.jpg",

"https://res.cloudinary.com/bidlogix-test/image/upload/v1/local_test_data/3-4.jpg",

"https://res.cloudinary.com/bidlogix-test/image/upload/v1/local_test_data/3-5.jpg",

"https://res.cloudinary.com/bidlogix-test/image/upload/v1/local_test_data/3-6.jpg"

],

"currencyId":2,

"endTime":1488412800000,

"actualEndTime":null,

"status":4,

"winner":null,

"losers":null

},

{

"@class":".ItemReportModel",

"category":{

"@class":".CategoryModel",

"id":12,

"name":"Welding Manipulators - Rotators - Seam etc",

"code":null,

"selected":false,

"treeName":"Industrial Machinery",

"treeId":1,

"parentName":"Welding",

"parentId":10,

"children":null

},

"id":14,

"title":"Machine Lot 33",

"lotNumber":"3",

"currencyId":2,

"endTime":1488412800000,

"actualEndTime":null,

"status":4,

"winner":null,

"losers":null

},

{

"@class":".ItemReportModel",

"category":{

"@class":".CategoryModel",

"id":12,

"name":"Welding Manipulators - Rotators - Seam etc",

"code":null,

"selected":false,

"treeName":"Industrial Machinery",

"treeId":1,

"parentName":"Welding",

"parentId":10,

"children":null

},

"id":16,

"title":"Machine Lot 35",

"lotNumber":"5",

"currencyId":2,

"endTime":1488412800000,

"actualEndTime":null,

"status":4,

"winner":null,

"losers":null

},

{

"@class":".ItemReportModel",

"category":{

"@class":".CategoryModel",

"id":14,

"name":"Welding Miscellaneous",

"code":null,

"selected":false,

"treeName":"Industrial Machinery",

"treeId":1,

"parentName":"Welding",

"parentId":10,

"children":null

},

"id":11,

"title":"Machine Lot 30",

"lotNumber":"1",

"currencyId":2,

"endTime":1487936727000,

"actualEndTime":null,

"status":4,

"winner":{

"@class":".RegistrantReportModel",

"bidOrOfferId":301,

"username":"harrytest",

"fullname":"harry hew",

"email":"harry@ibid.com",

"status":1,

"paddleNumber":5003,

"externalUserRef":null,

"userId":4,

"amount":550,

"reserve":false,

"commissionBid":false,

"placed":1254395100000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

},

"losers":[

{

"@class":".RegistrantReportModel",

"bidOrOfferId":300,

"username":"sallytest",

"fullname":"sally sue",

"email":"sally@ibid.com",

"status":1,

"paddleNumber":5002,

"externalUserRef":null,

"userId":5,

"amount":500,

"reserve":false,

"commissionBid":false,

"placed":1254394800000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

}

]

},

{

"@class":".ItemReportModel",

"category":{

"@class":".CategoryModel",

"id":14,

"name":"Welding Miscellaneous",

"code":null,

"selected":false,

"treeName":"Industrial Machinery",

"treeId":1,

"parentName":"Welding",

"parentId":10,

"children":null

},

"id":13,

"title":"Machine Lot 32",

"lotNumber":"2a",

"currencyId":2,

"endTime":1236675600000,

"actualEndTime":null,

"status":4,

"winner":{

"@class":".RegistrantReportModel",

"bidOrOfferId":309,

"username":"sallytest",

"fullname":"sally sue",

"email":"sally@ibid.com",

"status":1,

"paddleNumber":5002,

"externalUserRef":null,

"userId":5,

"amount":950,

"reserve":false,

"commissionBid":false,

"placed":1236673800000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

},

"losers":[

{

"@class":".RegistrantReportModel",

"bidOrOfferId":308,

"username":"harrytest",

"fullname":"harry hew",

"email":"harry@ibid.com",

"status":1,

"paddleNumber":5003,

"externalUserRef":null,

"userId":4,

"amount":900,

"reserve":false,

"commissionBid":false,

"placed":1236673500000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

},

{

"@class":".RegistrantReportModel",

"bidOrOfferId":307,

"username":"sallytest",

"fullname":"sally sue",

"email":"sally@ibid.com",

"status":1,

"paddleNumber":5002,

"externalUserRef":null,

"userId":5,

"amount":850,

"reserve":false,

"commissionBid":false,

"placed":1236673200000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

},

{

"@class":".RegistrantReportModel",

"bidOrOfferId":306,

"username":"harrytest",

"fullname":"harry hew",

"email":"harry@ibid.com",

"status":1,

"paddleNumber":5003,

"externalUserRef":null,

"userId":4,

"amount":800,

"reserve":false,

"commissionBid":false,

"placed":1236672900000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

}

]

},

{

"@class":".ItemReportModel",

"category":{

"@class":".CategoryModel",

"id":23,

"name":"Wire Drawing - Spring Production",

"code":null,

"selected":false,

"treeName":"Industrial Machinery",

"treeId":1,

"parentName":"Fastener Machines",

"parentId":20,

"children":null

},

"id":12,

"title":"Machine Lot 31",

"lotNumber":"2",

"currencyId":2,

"endTime":1236675600000,

"actualEndTime":null,

"status":4,

"winner":{

"@class":".RegistrantReportModel",

"bidOrOfferId":305,

"username":"sallytest",

"fullname":"sally sue",

"email":"sally@ibid.com",

"status":1,

"paddleNumber":5002,

"externalUserRef":null,

"userId":5,

"amount":950,

"reserve":false,

"commissionBid":false,

"placed":1236673800000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

},

"losers":[

{

"@class":".RegistrantReportModel",

"bidOrOfferId":304,

"username":"harrytest",

"fullname":"harry hew",

"email":"harry@ibid.com",

"status":1,

"paddleNumber":5003,

"externalUserRef":null,

"userId":4,

"amount":900,

"reserve":false,

"commissionBid":false,

"placed":1236673500000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

},

{

"@class":".RegistrantReportModel",

"bidOrOfferId":303,

"username":"sallytest",

"fullname":"sally sue",

"email":"sally@ibid.com",

"status":1,

"paddleNumber":5002,

"externalUserRef":null,

"userId":5,

"amount":850,

"reserve":false,

"commissionBid":false,

"placed":1236673200000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

},

{

"@class":".RegistrantReportModel",

"bidOrOfferId":302,

"username":"harrytest",

"fullname":"harry hew",

"email":"harry@ibid.com",

"status":1,

"paddleNumber":5003,

"externalUserRef":null,

"userId":4,

"amount":800,

"reserve":false,

"commissionBid":false,

"placed":1236672900000,

"numberOfUnitsWanted":null,

"shippingType":null,

"numberOfOffers":null

}

]

},

{

"@class":".ItemReportModel",

"category":{

"@class":".CategoryModel",

"id":23,

"name":"Wire Drawing - Spring Production",

"code":null,

"selected":false,

"treeName":"Industrial Machinery",

"treeId":1,

"parentName":"Fastener Machines",

"parentId":20,

"children":null

},

"id":15,

"title":"Machine Lot 34",

"lotNumber":"4",

"currencyId":2,

"endTime":1488412800000,

"actualEndTime":null,

"status":4,

"winner":null,

"losers":null

},

{

"@class":".ItemReportModel",

"category":{

"@class":".CategoryModel",

"id":23,

"name":"Wire Drawing - Spring Production",

"code":null,

"selected":false,

"treeName":"Industrial Machinery",

"treeId":1,

"parentName":"Fastener Machines",

"parentId":20,

"children":null

},

"id":17,

"title":"Machine Lot 36",

"lotNumber":"6",

"currencyId":2,

"endTime":1488412800000,

"actualEndTime":null,

"status":4,

"winner":null,

"losers":null

}

]

}

},

"webAppContext":"300"

}

Error Response

Code: 401 UNAUTHORIZED

Example: { error : "Log in" }

Code: 422 Unprocessable Entry

Example: { error : ["<field_name>"] }

Call: Auction Reports Print

Description

URL

Key and Adaptations

Method

Security

Query String Parameters

Success Response

Error Response

Related Articles