Skip to main content

Items Report By UUID

Description​

The auction Items Report by UUID call reports details on specific item(s). This includes information such as the item's category id, title and lot number, end time, etc.

The API must be structured correctly and have the correct security in place. See our document Troubleshooting.

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

Please Note

Items Report by UUID is limited to 97 UUIDs in the URL when requesting multiple items.

Making a request​

URL​

/reports/items/{clientId}/{itemUuids}

HTTP Method​

GET

Headers​

KeyValue
bdxapi_nameBidlogix API Signature
Content-Typeapplication/json

Path Parameters and Adaptations​

ParameterValue
clientIdyour bidlogix Client ID
itemUuidsUUID of the item(s) you wish to retrieve information for

Optional Query Parameters​

ParameterValue
includeImagesthis is set to true or false to enable image URL retrieval

Fetch reports for multiple items by providing a comma seperated set of UUIDs in the itemUuids path parameter

Appending the query parameter: ?includeImages=true to the end of the request, will result in a response that includes URLs to the images of the items. This will include the cloudinary image URLs in the resulting report.

Also see API Introduction.

Examples​

Call

https://api.eu-west-2.staging.bidjs.com/reports/items/302/375608a7-98fd-425f-a686-362eb4f8fe18

Response

{
  "message": {
    "@class": ".DataPushPayload",
    "pushCode": "REPORTING_AUCTION",
    "models": {
      "auctionReport": {
        "@class": ".reporting.ItemsMinimalReportModel",
        "reportMeta": {
          "@class": ".ReportMetaModel",
          "reportType": 5,
          "reportObject": "ItemsMinimalReportModel",
          "reportMade": 1700734552498
        },
        "reportTitle": "Items Report false",
        "items": [
          {
            "@class": ".ItemMinimalReportModel",
            "id": 919689,
            "title": "Car 1 – none",
            "lotNumber": "1",
            "imageUrls": null,
            "purchaseOption": "None",
            "currencyId": 2,
            "unitOfMeasurement": "",
            "numberOfUnits": 1,
            "endTime": 1701327600000,
            "actualEndTime": null,
            "status": 4,
            "derivedStatus": 4,
            "categoryId": 546,
            "categoryUuid": "88b7962f-9350-11ea-9b07-0aad12b14bdc",
            "vendorId": 3,
            "vendorUuid": "8a72f15f-9350-11ea-9b07-0aad12b14bdc",
            "charges": 0,
            "uuid": "375608a7-98fd-425f-a686-362eb4f8fe18"
          }
        ]
      }
    },
    "webAppContext": "302"
  }
}

Errors​

codeexample
401 UNAUTHORIZED{ error : "Log in" }
422 Unprocessable Entry{ error : ["<field_name>"] }
400 BAD REQUESTjson {"@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}