Description

The Auction Item Reports call reports details on specific item(s) and the bids and offers made on them. This includes information such as the item's category, title and lot number, end time, 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/auctionitem?ids=itemIds&clientId=your_bidlogix_client_id


Key and Adaptations

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

Setting includeImages=true will include the cloudinary image URLs in the resulting json data structure.

Note that the returned "winner" field is the accepted offer, if there is one, otherwise it's the highest bid. 


Method

Http Method: GET


Security

See Bidlogix API


Query String Parameters


itemIds=comma separated list of item ids

clientId=your_bidlogix_client_id

[includeImages=true|false]

where your_bidlogix_client_id is the id of your bidlogix web application id.

Setting includeImages=true will include the cloudinary image URLs in the resulting json data structure.

Please also see Query String Parameters


Example 1: Success Response

{

   "@class":".DataPushPayload",

   "pushCode":"REPORTING_AUCTION",

   "models":{

      "auctionReport":{

         "@class":".reporting.ItemsReportModel",

         "reportMeta":{

            "@class":".ReportMetaModel",

            "reportType":5,

            "reportObject":"ItemsReportModel",

            "reportMade":1488971982859

         },

         "reportTitle":"Items Report",

         "items":[

            {

               "@class":".ItemReportModel",

               "category":{

                  "@class":".CategoryModel",

                  "id":122,

                  "name":"Food Packaging",

                  "code":null,

                  "selected":false,

                  "treeName":"Industrial Machinery",

                  "treeId":1,

                  "parentName":"Food Processing",

                  "parentId":120,

                  "children":null

               },

               "id":223,

               "title":"test lot make offer",

               "lotNumber":"5",

               "purchaseOption":"MAKE_OFFER",

               "currencyId":2,

               "unitOfMeasurement":"",

               "numberOfUnits":1,

               "endTime":1520294400000,

               "actualEndTime":null,

               "status":4,

               "winner":{

                  "@class":".RegistrantReportModel",

                  "bidOrOfferId":17,

                  "type":"offer",

                  "username":"harrytest",

                  "fullname":"harry hew",

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

                  "status":2,

                  "paddleNumber":5000,

                  "externalUserRef":null,

                  "userId":44,

                  "amount":120,

                  "reserve":false,

                  "commissionBid":false,

                  "placed":1488902962000,

                  "numberOfUnitsWanted":1,

                  "shippingType":0,

                  "numberOfOffers":2

               },

               "losers":[

                  {

                     "@class":".RegistrantReportModel",

                     "bidOrOfferId":16,

                     "type":"offer",

                     "username":"harrytest",

                     "fullname":"harry hew",

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

                     "status":3,

                     "paddleNumber":5000,

                     "externalUserRef":null,

                     "userId":44,

                     "amount":100,

                     "reserve":false,

                     "commissionBid":false,

                     "placed":1488902864000,

                     "numberOfUnitsWanted":1,

                     "shippingType":0,

                     "numberOfOffers":1

                  },

                  {

                     "@class":".RegistrantReportModel",

                     "bidOrOfferId":3082,

                     "type":"bid",

                     "username":"harrytest",

                     "fullname":"harry hew",

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

                     "status":1,

                     "paddleNumber":5000,

                     "externalUserRef":null,

                     "userId":4,

                     "amount":10,

                     "reserve":false,

                     "commissionBid":false,

                     "placed":1488902334000,

                     "numberOfUnitsWanted":null,

                     "shippingType":null,

                     "numberOfOffers":null

                  },

                  {

                     "@class":".RegistrantReportModel",

                     "bidOrOfferId":3086,

                     "type":"bid",

                     "username":"sallytest",

                     "fullname":"sally sue",

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

                     "status":1,

                     "paddleNumber":5002,

                     "externalUserRef":null,

                     "userId":5,

                     "amount":20,

                     "reserve":false,

                     "commissionBid":false,

                     "placed":1488902842000,

                     "numberOfUnitsWanted":null,

                     "shippingType":null,

                     "numberOfOffers":null

                  }

               ]

            }

         ]

      }

   },

   "webAppContext":"1"

}


Example 2: includeImages=true

{

   "@class":".DataPushPayload",

   "pushCode":"REPORTING_AUCTION",

   "models":{

      "auctionReport":{

         "@class":".reporting.ItemsReportModel",

         "reportMeta":{

            "@class":".ReportMetaModel",

            "reportType":5,

            "reportObject":"ItemsReportModel",

            "reportMade":1488971982859

         },

         "reportTitle":"Items Report",

         "items":[

            {

               "@class":".ItemReportModel",

               "category":{

                  "@class":".CategoryModel",

                  "id":122,

                  "name":"Food Packaging",

                  "code":null,

                  "selected":false,

                  "treeName":"Industrial Machinery",

                  "treeId":1,

                  "parentName":"Food Processing",

                  "parentId":120,

                  "children":null

               },

               "id":223,

               "title":"test lot make offer",

               "lotNumber":"5",

               "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"

               ],

               "purchaseOption":"MAKE_OFFER",

               "currencyId":2,

               "unitOfMeasurement":"",

               "numberOfUnits":1,

               "endTime":1520294400000,

               "actualEndTime":null,

               "status":4,

               "winner":{

                  "@class":".RegistrantReportModel",

                  "bidOrOfferId":17,

                  "type":"offer",

                  "username":"harrytest",

                  "fullname":"harry hew",

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

                  "status":2,

                  "paddleNumber":5000,

                  "externalUserRef":null,

                  "userId":44,

                  "amount":120,

                  "reserve":false,

                  "commissionBid":false,

                  "placed":1488902962000,

                  "numberOfUnitsWanted":1,

                  "shippingType":0,

                  "numberOfOffers":2

               },

               "losers":[

                  {

                     "@class":".RegistrantReportModel",

                     "bidOrOfferId":16,

                     "type":"offer",

                     "username":"harrytest",

                     "fullname":"harry hew",

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

                     "status":3,

                     "paddleNumber":5000,

                     "externalUserRef":null,

                     "userId":44,

                     "amount":100,

                     "reserve":false,

                     "commissionBid":false,

                     "placed":1488902864000,

                     "numberOfUnitsWanted":1,

                     "shippingType":0,

                     "numberOfOffers":1

                  },

                  {

                     "@class":".RegistrantReportModel",

                     "bidOrOfferId":3082,

                     "type":"bid",

                     "username":"harrytest",

                     "fullname":"harry hew",

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

                     "status":1,

                     "paddleNumber":5000,

                     "externalUserRef":null,

                     "userId":4,

                     "amount":10,

                     "reserve":false,

                     "commissionBid":false,

                     "placed":1488902334000,

                     "numberOfUnitsWanted":null,

                     "shippingType":null,

                     "numberOfOffers":null

                  },

                  {

                     "@class":".RegistrantReportModel",

                     "bidOrOfferId":3086,

                     "type":"bid",

                     "username":"sallytest",

                     "fullname":"sally sue",

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

                     "status":1,

                     "paddleNumber":5002,

                     "externalUserRef":null,

                     "userId":5,

                     "amount":20,

                     "reserve":false,

                     "commissionBid":false,

                     "placed":1488902842000,

                     "numberOfUnitsWanted":null,

                     "shippingType":null,

                     "numberOfOffers":null

                  }

               ]

            }

         ]

      }

   },

   "webAppContext":"1"

}


Error Response


Code: 401 UNAUTHORIZED 

Example: { error : "Log in" }

Code: 422 Unprocessable Entry 

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

Code: 400 Bad Request

Example:

{

"@class":".ErrorModel",

"failed":true,

"field":null,

"code":"REPORTING_API",

"message":"Invalid ids parameter - only numbers and commas allowed; actual value passed=invalid_argument",

"loggedIn":false

}