VTex Catalog API — Category Specification

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — Category Specification
  description: 'VTex Catalog API — Category Specification. 2 operations. Lead operation: VTex Get specifications by category
    ID. Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Category Specification
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-category-specification
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — Category Specification business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog_system-pub-specification-field-listByCategoryId-categoryId
      path: /api/catalog_system/pub/specification/field/listByCategoryId/{categoryId}
      operations:
      - name: specificationsbycategoryid
        method: GET
        description: VTex Get specifications by category ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: categoryId
          in: path
          type: integer
          description: Category ID.
          required: true
    - name: api-catalog_system-pub-specification-field-listTreeByCategoryId-categoryId
      path: /api/catalog_system/pub/specification/field/listTreeByCategoryId/{categoryId}
      operations:
      - name: specificationstreebycategoryid
        method: GET
        description: VTex Get specifications tree by category ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: categoryId
          in: path
          type: integer
          description: Category ID.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-category-specification-rest
    port: 8080
    description: REST adapter for VTex Catalog API — Category Specification. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/catalog-system/pub/specification/field/listbycategoryid/{categoryid}
      name: api-catalog-system-pub-specification-field-listbycategoryid-categoryid
      description: REST surface for api-catalog_system-pub-specification-field-listByCategoryId-categoryId.
      operations:
      - method: GET
        name: specificationsbycategoryid
        description: VTex Get specifications by category ID
        call: catalog-category-specification.specificationsbycategoryid
        with:
          categoryId: rest.categoryId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pub/specification/field/listtreebycategoryid/{categoryid}
      name: api-catalog-system-pub-specification-field-listtreebycategoryid-categoryid
      description: REST surface for api-catalog_system-pub-specification-field-listTreeByCategoryId-categoryId.
      operations:
      - method: GET
        name: specificationstreebycategoryid
        description: VTex Get specifications tree by category ID
        call: catalog-category-specification.specificationstreebycategoryid
        with:
          categoryId: rest.categoryId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-category-specification-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — Category Specification. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vtex-get-specifications-category-id
      description: VTex Get specifications by category ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-category-specification.specificationsbycategoryid
      with:
        categoryId: tools.categoryId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-specifications-tree-category
      description: VTex Get specifications tree by category ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-category-specification.specificationstreebycategoryid
      with:
        categoryId: tools.categoryId
      outputParameters:
      - type: object
        mapping: $.