1 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Roblox.Inventory.Api.Models.IItemModel — openapi

Model representing an inventory item

Properties

NameTypeRequiredDescription
idintegerfalseThe ID of the item
namestringfalseThe name of the item
typeintegerfalseThe type of the item ['Asset' = 0, 'GamePass' = 1, 'Badge' = 2, 'Bundle' = 3, 'Avatar' = 4]
instanceIdintegerfalseThe instance id of the item if applicable

Complete Schema

{
  "description": "Model representing an inventory item",
  "type": "object",
  "properties": {
    "id": {
      "format": "int64",
      "description": "The ID of the item",
      "type": "integer",
      "readOnly": true
    },
    "name": {
      "description": "The name of the item",
      "type": "string",
      "readOnly": true
    },
    "type": {
      "format": "int32",
      "description": "The type of the item ['Asset' = 0, 'GamePass' = 1, 'Badge' = 2, 'Bundle' = 3, 'Avatar' = 4]",
      "enum": [
        0,
        1,
        2,
        3,
        4
      ],
      "type": "integer",
      "readOnly": true
    },
    "instanceId": {
      "format": "int64",
      "description": "The instance id of the item if applicable",
      "type": "integer",
      "readOnly": true
    }
  },
  "additionalProperties": false
}