VTex Catalog API — Product Specification

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — Product Specification
  description: 'VTex Catalog API — Product Specification. 7 operations. Lead operation: VTex Get product specifications and
    their information by product ID. Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Product 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-product-specification
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — Product Specification business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-pvt-product-productId-specification
      path: /api/catalog/pvt/product/{productId}/specification
      operations:
      - name: getproductspecificationbyproductid
        method: GET
        description: VTex Get product specifications and their information by product ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: integer
          description: Product's unique numerical identifier.
          required: true
      - name: post
        method: POST
        description: VTex Associate product specification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: integer
          description: Product's unique numerical identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deleteallproductspecifications
        method: DELETE
        description: VTex Delete all product specifications by product ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: integer
          description: Product's unique numerical identifier.
          required: true
    - name: api-catalog-pvt-product-productId-specification-specificationId
      path: /api/catalog/pvt/product/{productId}/specification/{specificationId}
      operations:
      - name: deleteaproductspecification
        method: DELETE
        description: VTex Delete a product specification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: integer
          description: Product's unique numerical identifier.
          required: true
        - name: specificationId
          in: path
          type: integer
          description: Product specification's unique numerical identifier.
          required: true
    - name: api-catalog-pvt-product-productId-specificationvalue
      path: /api/catalog/pvt/product/{productId}/specificationvalue
      operations:
      - name: put
        method: PUT
        description: VTex Associate product specification using specification name and group name
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: integer
          description: Product's unique numerical identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog_system-pvt-products-productId-specification
      path: /api/catalog_system/pvt/products/{productId}/specification
      operations:
      - name: getproductspecification
        method: GET
        description: VTex Get product specifications by product ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: integer
          description: Product's unique numerical identifier.
          required: true
      - name: updateproductspecification
        method: POST
        description: VTex Update product specification by product ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: integer
          description: Product's unique identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-product-specification-rest
    port: 8080
    description: REST adapter for VTex Catalog API — Product Specification. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/catalog/pvt/product/{productid}/specification
      name: api-catalog-pvt-product-productid-specification
      description: REST surface for api-catalog-pvt-product-productId-specification.
      operations:
      - method: GET
        name: getproductspecificationbyproductid
        description: VTex Get product specifications and their information by product ID
        call: catalog-product-specification.getproductspecificationbyproductid
        with:
          productId: rest.productId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: VTex Associate product specification
        call: catalog-product-specification.post
        with:
          productId: rest.productId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteallproductspecifications
        description: VTex Delete all product specifications by product ID
        call: catalog-product-specification.deleteallproductspecifications
        with:
          productId: rest.productId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/product/{productid}/specification/{specificationid}
      name: api-catalog-pvt-product-productid-specification-specificationid
      description: REST surface for api-catalog-pvt-product-productId-specification-specificationId.
      operations:
      - method: DELETE
        name: deleteaproductspecification
        description: VTex Delete a product specification
        call: catalog-product-specification.deleteaproductspecification
        with:
          productId: rest.productId
          specificationId: rest.specificationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/product/{productid}/specificationvalue
      name: api-catalog-pvt-product-productid-specificationvalue
      description: REST surface for api-catalog-pvt-product-productId-specificationvalue.
      operations:
      - method: PUT
        name: put
        description: VTex Associate product specification using specification name and group name
        call: catalog-product-specification.put
        with:
          productId: rest.productId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/products/{productid}/specification
      name: api-catalog-system-pvt-products-productid-specification
      description: REST surface for api-catalog_system-pvt-products-productId-specification.
      operations:
      - method: GET
        name: getproductspecification
        description: VTex Get product specifications by product ID
        call: catalog-product-specification.getproductspecification
        with:
          productId: rest.productId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: updateproductspecification
        description: VTex Update product specification by product ID
        call: catalog-product-specification.updateproductspecification
        with:
          productId: rest.productId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-product-specification-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — Product Specification. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vtex-get-product-specifications-and
      description: VTex Get product specifications and their information by product ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-product-specification.getproductspecificationbyproductid
      with:
        productId: tools.productId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-associate-product-specification
      description: VTex Associate product specification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-product-specification.post
      with:
        productId: tools.productId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-all-product-specifications
      description: VTex Delete all product specifications by product ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-product-specification.deleteallproductspecifications
      with:
        productId: tools.productId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-product-specification
      description: VTex Delete a product specification
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-product-specification.deleteaproductspecification
      with:
        productId: tools.productId
        specificationId: tools.specificationId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-associate-product-specification-using
      description: VTex Associate product specification using specification name and group name
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-product-specification.put
      with:
        productId: tools.productId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-product-specifications-product
      description: VTex Get product specifications by product ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-product-specification.getproductspecification
      with:
        productId: tools.productId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-product-specification-product
      description: VTex Update product specification by product ID
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-product-specification.updateproductspecification
      with:
        productId: tools.productId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.