Serial Number Collection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed/main/json-schema/lightspeed-serial-number-collection-schema.json",
  "title": "Serial Number Collection",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lightspeed-serial-numbers-api-openapi.yml#/components/schemas/SerialNumberCollection",
  "properties": {
    "data": {
      "description": "An array of Serial Numbers wrapped in top level `data` object.",
      "items": {
        "$ref": "#/$defs/SerialNumber"
      },
      "type": "array"
    },
    "version": {
      "$ref": "#/$defs/Version"
    }
  },
  "type": "object",
  "$defs": {
    "SerialNumber": {
      "properties": {
        "code": {
          "description": "The actual serial number value.",
          "type": "string"
        },
        "id": {
          "description": "Auto-generated object ID.",
          "type": "string"
        },
        "line_item_id": {
          "description": "The ID of the sale line item where this serial number was sold, or null.",
          "format": "uuid",
          "type": [
            "string",
            "null"
          ]
        },
        "outlet_id": {
          "description": "The ID of the outlet where the serial number is located.",
          "format": "uuid",
          "type": "string"
        },
        "product_id": {
          "description": "The ID of the product associated with the serial number.",
          "format": "uuid",
          "type": "string"
        },
        "sale_id": {
          "description": "The ID of the sale where this serial number was sold, or null.",
          "format": "uuid",
          "type": [
            "string",
            "null"
          ]
        },
        "version": {
          "description": "Auto-incrementing object version number.",
          "format": "int64",
          "type": "integer"
        }
      },
      "title": "SerialNumber",
      "type": "object"
    },
    "Version": {
      "description": "An object containing the highest and lowest version numbers for all items of the returned collection.",
      "properties": {
        "max": {
          "description": "Highest version number of the payload, or `null` when the result set is empty.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        },
        "min": {
          "description": "Lowest version number of the payload, or `null` when the result set is empty.",
          "format": "int64",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "max",
        "min"
      ],
      "type": "object"
    }
  }
}