VTex Catalog API - Seller Portal — Category

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API - Seller Portal — Category
  description: 'VTex Catalog API - Seller Portal — Category. 4 operations. Lead operation: VTex Get Category Tree. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Category
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-api-seller-portal-category
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API - Seller Portal — Category business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-seller-portal-category-tree
      path: /api/catalog-seller-portal/category-tree
      operations:
      - name: getcategorytree
        method: GET
        description: VTex Get Category Tree
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: depth
          in: query
          type: integer
          description: Category tree level.
      - name: updatecategorytree
        method: PUT
        description: VTex Update Category Tree
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-catalog-seller-portal-category-tree-categories
      path: /api/catalog-seller-portal/category-tree/categories
      operations:
      - name: createcategory
        method: POST
        description: VTex Create Category
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-catalog-seller-portal-category-tree-categories-categoryId
      path: /api/catalog-seller-portal/category-tree/categories/{categoryId}
      operations:
      - name: getbyid
        method: GET
        description: VTex Get Category by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: categoryId
          in: path
          type: string
          description: Category unique identifier number.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-api-seller-portal-category-rest
    port: 8080
    description: REST adapter for VTex Catalog API - Seller Portal — Category. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/catalog-seller-portal/category-tree
      name: api-catalog-seller-portal-category-tree
      description: REST surface for api-catalog-seller-portal-category-tree.
      operations:
      - method: GET
        name: getcategorytree
        description: VTex Get Category Tree
        call: catalog-api-seller-portal-category.getcategorytree
        with:
          depth: rest.depth
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecategorytree
        description: VTex Update Category Tree
        call: catalog-api-seller-portal-category.updatecategorytree
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-seller-portal/category-tree/categories
      name: api-catalog-seller-portal-category-tree-categories
      description: REST surface for api-catalog-seller-portal-category-tree-categories.
      operations:
      - method: POST
        name: createcategory
        description: VTex Create Category
        call: catalog-api-seller-portal-category.createcategory
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-seller-portal/category-tree/categories/{categoryid}
      name: api-catalog-seller-portal-category-tree-categories-categoryid
      description: REST surface for api-catalog-seller-portal-category-tree-categories-categoryId.
      operations:
      - method: GET
        name: getbyid
        description: VTex Get Category by ID
        call: catalog-api-seller-portal-category.getbyid
        with:
          categoryId: rest.categoryId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-api-seller-portal-category-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API - Seller Portal — Category. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vtex-get-category-tree
      description: VTex Get Category Tree
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-category.getcategorytree
      with:
        depth: tools.depth
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-category-tree
      description: VTex Update Category Tree
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-category.updatecategorytree
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-category
      description: VTex Create Category
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-api-seller-portal-category.createcategory
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-category-id
      description: VTex Get Category by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-category.getbyid
      with:
        categoryId: tools.categoryId
      outputParameters:
      - type: object
        mapping: $.