VTex Catalog API — Specification Group

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — Specification Group
  description: 'VTex Catalog API — Specification Group. 4 operations. Lead operation: VTex Create specification group. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Specification Group
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-specification-group
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — Specification Group business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-pvt-specificationgroup
      path: /api/catalog/pvt/specificationgroup
      operations:
      - name: specificationgroupinsert2
        method: POST
        description: VTex Create specification group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-catalog-pvt-specificationgroup-groupId
      path: /api/catalog/pvt/specificationgroup/{groupId}
      operations:
      - name: put
        method: PUT
        description: VTex Update specification group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: integer
          description: Group's unique numerical identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog_system-pub-specification-groupGet-groupId
      path: /api/catalog_system/pub/specification/groupGet/{groupId}
      operations:
      - name: specificationsgroupget
        method: GET
        description: VTex Get specification group
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: groupId
          in: path
          type: string
          description: Specification group ID.
          required: true
    - name: api-catalog_system-pvt-specification-groupbycategory-categoryId
      path: /api/catalog_system/pvt/specification/groupbycategory/{categoryId}
      operations:
      - name: specificationsgrouplistbycategory
        method: GET
        description: VTex List specification group by category
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: categoryId
          in: path
          type: string
          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-specification-group-rest
    port: 8080
    description: REST adapter for VTex Catalog API — Specification Group. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/catalog/pvt/specificationgroup
      name: api-catalog-pvt-specificationgroup
      description: REST surface for api-catalog-pvt-specificationgroup.
      operations:
      - method: POST
        name: specificationgroupinsert2
        description: VTex Create specification group
        call: catalog-specification-group.specificationgroupinsert2
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/specificationgroup/{groupid}
      name: api-catalog-pvt-specificationgroup-groupid
      description: REST surface for api-catalog-pvt-specificationgroup-groupId.
      operations:
      - method: PUT
        name: put
        description: VTex Update specification group
        call: catalog-specification-group.put
        with:
          groupId: rest.groupId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pub/specification/groupget/{groupid}
      name: api-catalog-system-pub-specification-groupget-groupid
      description: REST surface for api-catalog_system-pub-specification-groupGet-groupId.
      operations:
      - method: GET
        name: specificationsgroupget
        description: VTex Get specification group
        call: catalog-specification-group.specificationsgroupget
        with:
          groupId: rest.groupId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/specification/groupbycategory/{categoryid}
      name: api-catalog-system-pvt-specification-groupbycategory-categoryid
      description: REST surface for api-catalog_system-pvt-specification-groupbycategory-categoryId.
      operations:
      - method: GET
        name: specificationsgrouplistbycategory
        description: VTex List specification group by category
        call: catalog-specification-group.specificationsgrouplistbycategory
        with:
          categoryId: rest.categoryId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-specification-group-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — Specification Group. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-create-specification-group
      description: VTex Create specification group
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-specification-group.specificationgroupinsert2
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-specification-group
      description: VTex Update specification group
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-specification-group.put
      with:
        groupId: tools.groupId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-specification-group
      description: VTex Get specification group
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-specification-group.specificationsgroupget
      with:
        groupId: tools.groupId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-list-specification-group-category
      description: VTex List specification group by category
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-specification-group.specificationsgrouplistbycategory
      with:
        categoryId: tools.categoryId
      outputParameters:
      - type: object
        mapping: $.