items-apiItemDTO

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed/main/json-schema/lightspeed-items-api-item-dto-schema.json",
  "title": "items-apiItemDTO",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/lightspeed-k-series-openapi.yml#/components/schemas/items-apiItemDTO",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "The unique identifier for the item."
    },
    "name": {
      "type": "string",
      "description": "The name of the item."
    },
    "docketName": {
      "$ref": "#/$defs/items-apiDocketName"
    },
    "sku": {
      "$ref": "#/$defs/items-apiSku"
    },
    "active": {
      "$ref": "#/$defs/items-apiActive"
    },
    "barcode": {
      "type": "string",
      "description": "The item barcode."
    },
    "barcodes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "A list of barcodes associated with the item."
    },
    "accountingGroup": {
      "$ref": "#/$defs/items-apiAccountingGroupDTO"
    },
    "statisticGroups": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/items-apiStatisticGroupDTO"
      },
      "description": "List of statistic groups associated with the item."
    },
    "costPrice": {
      "$ref": "#/$defs/items-apiCostPrice"
    },
    "prices": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/items-apiPriceDTO"
      },
      "description": "List of prices associated with the item."
    },
    "sharingType": {
      "type": "string",
      "enum": [
        "GLOBAL_NO_BL",
        "GLOBAL",
        "LOCAL",
        "SHARED"
      ],
      "description": "How the item is shared."
    },
    "priceMode": {
      "type": "string",
      "enum": [
        "AMOUNT",
        "PERCENT",
        "POSITIVE_OPEN_PRICE",
        "NEGATIVE_OPEN_PRICE"
      ],
      "default": "AMOUNT",
      "description": "The type of price for the item."
    },
    "inventorySource": {
      "type": "string",
      "enum": [
        "PURCHASED",
        "PRODUCED"
      ],
      "description": "Source of inventory for the item."
    },
    "disabled": {
      "type": "boolean",
      "description": "Whether or not stock management is disabled for the item."
    },
    "contentDimension": {
      "description": "How the item is measured for stock management.",
      "type": "string",
      "enum": [
        "DIMENSION_LESS",
        "VOLUME",
        "MASS"
      ]
    },
    "contentUom": {
      "type": "string",
      "description": "The unit of measure of the item for stock management."
    },
    "contentValue": {
      "type": "number",
      "description": "The measurement value."
    },
    "itemType": {
      "type": "string",
      "enum": [
        "ITEM",
        "SEQUENCE",
        "GROUP",
        "SUB_ITEM"
      ],
      "description": "Type of the item."
    }
  },
  "$defs": {
    "items-apiAccountingGroupDTO": {
      "description": "The accounting group associated with the item.",
      "properties": {
        "id": {
          "format": "int64",
          "type": "integer",
          "description": "The unique identifier for the accounting group."
        },
        "name": {
          "type": "string",
          "description": "The name of the accounting group."
        }
      },
      "type": "object"
    },
    "items-apiActive": {
      "type": "boolean",
      "description": "Indicates whether or not the item is archived from the menu."
    },
    "items-apiCostPrice": {
      "type": "number",
      "description": "The cost price of the item."
    },
    "items-apiDocketName": {
      "maxLength": 64,
      "type": "string",
      "description": "The name used in the docket for the item."
    },
    "items-apiPriceDTO": {
      "properties": {
        "amount": {
          "type": "number",
          "description": "The item price."
        },
        "name": {
          "type": "string",
          "description": "The name for this item price."
        }
      },
      "type": "object"
    },
    "items-apiSku": {
      "maxLength": 32,
      "minLength": 1,
      "description": "A stock keeping unit.",
      "type": "string"
    },
    "items-apiStatisticGroupDTO": {
      "properties": {
        "category": {
          "type": "string",
          "description": "The name of the statistic group category."
        },
        "value": {
          "type": "string",
          "description": "The statistic group value."
        }
      },
      "type": "object"
    }
  }
}