Barcode Scanners · Schema

BarcodeLookupResponse

Product information returned from a barcode lookup API query.

BarcodesInventoryProduct LookupQR CodesRetailScanningSupply Chain

Properties

Name Type Description
barcode_number string The barcode number queried.
barcode_type string The barcode format/symbology.
barcode_image string URL of the barcode image.
product object
View JSON Schema on GitHub

JSON Schema

barcode-lookup-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/barcode-scanners/json-schema/barcode-lookup-schema.json",
  "title": "BarcodeLookupResponse",
  "description": "Product information returned from a barcode lookup API query.",
  "type": "object",
  "properties": {
    "barcode_number": {
      "type": "string",
      "description": "The barcode number queried."
    },
    "barcode_type": {
      "type": "string",
      "enum": ["UPC-A", "UPC-E", "EAN-13", "EAN-8", "ISBN-10", "ISBN-13", "QR Code", "Code 128", "Code 39", "Data Matrix", "PDF417"],
      "description": "The barcode format/symbology."
    },
    "barcode_image": {
      "type": "string",
      "format": "uri",
      "description": "URL of the barcode image."
    },
    "product": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "description": "Product name or title."
        },
        "description": {
          "type": "string",
          "description": "Product description."
        },
        "category": {
          "type": "string",
          "description": "Product category."
        },
        "brand": {
          "type": "string",
          "description": "Product brand or manufacturer."
        },
        "manufacturer": {
          "type": "string",
          "description": "Product manufacturer name."
        },
        "mpn": {
          "type": "string",
          "description": "Manufacturer Part Number."
        },
        "color": {
          "type": "string"
        },
        "size": {
          "type": "string"
        },
        "weight": {
          "type": "string"
        },
        "images": {
          "type": "array",
          "items": {
            "type": "string",
            "format": "uri"
          },
          "description": "Product image URLs."
        },
        "stores": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "store_name": {"type": "string"},
              "store_price": {"type": "string"},
              "product_url": {"type": "string", "format": "uri"}
            }
          },
          "description": "Retail store listings with prices."
        }
      },
      "required": ["title"]
    }
  },
  "required": ["barcode_number", "barcode_type", "product"]
}