VTEX · Schema

CategorySpecification

Array of objects.

CommerceE-CommerceRetailMarketplacePayments
View JSON Schema on GitHub

JSON Schema

vtex-categoryspecification-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CategorySpecification",
  "title": "CategorySpecification",
  "required": [
    "Name",
    "CategoryId",
    "FieldId",
    "IsActive",
    "IsStockKeepingUnit"
  ],
  "type": "array",
  "description": "Array of objects.",
  "items": {
    "type": "object",
    "description": "Object containing specification information.",
    "properties": {
      "Name": {
        "type": "string",
        "description": "Specification name. Limited to 100 characters.",
        "example": "Composition"
      },
      "CategoryId": {
        "type": "integer",
        "description": "Category ID.",
        "example": 1
      },
      "FieldId": {
        "type": "integer",
        "description": "Specification field ID.",
        "example": 1
      },
      "IsActive": {
        "type": "boolean",
        "description": "Defines if the specification is active.",
        "example": true
      },
      "IsStockKeepingUnit": {
        "type": "boolean",
        "description": "Defines if it is an SKU specification.",
        "example": true
      }
    }
  },
  "example": [
    {
      "Name": "Specification A",
      "CategoryId": 1,
      "FieldId": 33,
      "IsActive": true,
      "IsStockKeepingUnit": false
    },
    {
      "Name": "Specification B",
      "CategoryId": 1,
      "FieldId": 34,
      "IsActive": true,
      "IsStockKeepingUnit": false
    },
    {
      "Name": "Specification C",
      "CategoryId": 1,
      "FieldId": 35,
      "IsActive": false,
      "IsStockKeepingUnit": false
    }
  ]
}