Skip to main content

Images

Image record is generated whenever an image is attemped to be uploaded to the cloud. This data can be used to access analysis and further details.

POST /controllers/AssetPurityLite.ashx?action=list

List Properties

All transaction APIs return Asset/ Location related common attributes. Attributes specific to this API are:

PropertyTypeDescription
PurityDateTimedateImage capture date/ time
StatusIdintImage Processing Status
PurityStatusstringImage processing Status (text)
TagStatusstringString encoded JSON with full analysis

TagStatus

This analysis has shelf-by-shelf and product-by-product status in JSON format:

{
"tags": [
{
"ProductId": 24665,
"HasTag": 0,
"StockLevelList": [],
"StockLevel": 0,
"Tier": 2,
"isEmpty": false,
"IsForeign": false
},
{
"ProductId": 24664,
"HasTag": 0,
"StockLevelList": [],
"StockLevel": 0,
"Tier": 2,
"isEmpty": false,
"IsForeign": false
}
]
}

Attributes include:

  1. ProductId: id of the product recognized
  2. HasTag: whether the pricing tag was recognized
  3. StockLevelList: an array if there were multiple products stacked
  4. StockLevel: If depth analysis is enabled, %age stock estimated in the particular location
  5. Tier: Number of stacked products
  6. isEmpty: If no product was identified and it is empty space
  7. IsForeign: If the product is determined as foreign

Note:

  1. For the image analysis, isEmpty and isForeign are not important as those are derived attributes.

Detailed API

There is an additional api available to get more detailed analysis of each image.