PublicProduct

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stackit/main/json-schema/stackit-public-product-schema.json",
  "title": "PublicProduct",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/stackit-pim-openapi.yml#/components/schemas/PublicProduct",
  "properties": {
    "apiIdentifier": {
      "description": "Api identifier",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "categoryId": {
      "description": "The unique identifier for the category, which is object id from the DB",
      "type": [
        "string",
        "null"
      ]
    },
    "categoryName": {
      "description": "Generic categorization to structure the customer's invoice transparently (e.g. `Compute Engine`, `Database`, `Storage`)",
      "type": [
        "string",
        "null"
      ]
    },
    "description": {
      "description": "Description of the product",
      "type": "string"
    },
    "id": {
      "description": "Unique identifier of the product, which is object id from the DB",
      "type": [
        "string",
        "null"
      ]
    },
    "image": {
      "description": "URI of the category image",
      "format": "uri",
      "type": "string"
    },
    "language": {
      "description": "Language of the product",
      "type": "string"
    },
    "longName": {
      "description": "Extended name of the product",
      "type": "string"
    },
    "shortName": {
      "description": "An abbreviated name of the product",
      "type": "string"
    },
    "validStart": {
      "description": "Date when the current version was approved and became valid in PIM",
      "format": "date-time",
      "type": "string"
    },
    "version": {
      "description": "Number of the revision from PIM",
      "type": "string"
    }
  },
  "type": "object"
}