Response Structure

Successful responses (status code 200) will have the below structure. For errors see Error Codes

Fields

Field	Type	Description
success	boolean	Indicates whether the request was successful.
balance	integer	The remaining API request balance.
results	array	A list of matched products from the request.
results[].request	object	The original product request details.
results[].request.description	string	The description of the requested product.
results[].request.product_number	string	The product identifier number.
results[].request.product_name	string	The full product name of the requested product.
results[].request.full_price	float	The original price of the requested product.
results[].request.unit_price	float	The final price per unit after discounts.
results[].product_info	array	A list of matched product details with probabilities.
results[].product_info[].probability	float	Confidence score (0-1) for this product match.
results[].product_info[].upc	string	The UPC (Universal Product Code) of the product.
results[].product_info[].product_name	string	The name of the matched product.
results[].product_info[].brand	string	The brand name of the matched product.
results[].product_info[].sector	string	The sector classification of the product.
results[].product_info[].department	string	The department under which the product is categorized.
results[].product_info[].category	string	The category of the product (e.g., Crackers, Snacks).
results[].index	integer	The index position of this result in the original request array.

Example

{
  "success": true,
  "balance": 239,
  "results": [
    {
      "request": {
        "description": "KRO SALTINES",
        "product_number": "12345789",
        "product_name": null,
        "full_price": 6.99,
        "unit_price": 4.99
      },
      "product_info": [
        {
          "probability": 0.75,
          "upc": "11110090904",
          "product_name": "Kroger® Original Saltines Crackers",
          "brand": "Kroger",
          "sector": "Grocery",
          "department": "Snacks",
          "category": "Crackers"
        }
      ],
      "index": 0
    }
  ]
}