VTex Catalog API - Seller Portal — Product

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API - Seller Portal — Product
  description: 'VTex Catalog API - Seller Portal — Product. 6 operations. Lead operation: VTex Create Product. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Product
  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-product
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API - Seller Portal — Product business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-seller-portal-products
      path: /api/catalog-seller-portal/products
      operations:
      - name: postproduct
        method: POST
        description: VTex Create Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog-seller-portal-products-param
      path: /api/catalog-seller-portal/products/{param}
      operations:
      - name: getproductquery
        method: GET
        description: VTex Get Product by external ID,  SKU ID, SKU external ID or slug
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: param
          in: path
          type: string
          description: 'This part of the path must follow this format: `{param}={value}`. Replace `{param}` with the name
            of the parameter used to fetch a product, which can be one of '
          required: true
    - name: api-catalog-seller-portal-products-productId
      path: /api/catalog-seller-portal/products/{productId}
      operations:
      - name: getproduct
        method: GET
        description: VTex Get Product by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: string
          description: Product unique identifier number.
          required: true
      - name: putproduct
        method: PUT
        description: VTex Update Product
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: string
          description: Product unique identifier number.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog-seller-portal-products-productId-description
      path: /api/catalog-seller-portal/products/{productId}/description
      operations:
      - name: getproductdescription
        method: GET
        description: VTex Get Product Description by Product ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: string
          description: Product unique identifier number.
          required: true
      - name: putproductdescription
        method: PUT
        description: VTex Update Product Description by Product ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: productId
          in: path
          type: string
          description: Product unique identifier number.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-api-seller-portal-product-rest
    port: 8080
    description: REST adapter for VTex Catalog API - Seller Portal — Product. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/catalog-seller-portal/products
      name: api-catalog-seller-portal-products
      description: REST surface for api-catalog-seller-portal-products.
      operations:
      - method: POST
        name: postproduct
        description: VTex Create Product
        call: catalog-api-seller-portal-product.postproduct
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-seller-portal/products/{param}
      name: api-catalog-seller-portal-products-param
      description: REST surface for api-catalog-seller-portal-products-param.
      operations:
      - method: GET
        name: getproductquery
        description: VTex Get Product by external ID,  SKU ID, SKU external ID or slug
        call: catalog-api-seller-portal-product.getproductquery
        with:
          param: rest.param
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-seller-portal/products/{productid}
      name: api-catalog-seller-portal-products-productid
      description: REST surface for api-catalog-seller-portal-products-productId.
      operations:
      - method: GET
        name: getproduct
        description: VTex Get Product by ID
        call: catalog-api-seller-portal-product.getproduct
        with:
          productId: rest.productId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putproduct
        description: VTex Update Product
        call: catalog-api-seller-portal-product.putproduct
        with:
          productId: rest.productId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-seller-portal/products/{productid}/description
      name: api-catalog-seller-portal-products-productid-description
      description: REST surface for api-catalog-seller-portal-products-productId-description.
      operations:
      - method: GET
        name: getproductdescription
        description: VTex Get Product Description by Product ID
        call: catalog-api-seller-portal-product.getproductdescription
        with:
          productId: rest.productId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putproductdescription
        description: VTex Update Product Description by Product ID
        call: catalog-api-seller-portal-product.putproductdescription
        with:
          productId: rest.productId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-api-seller-portal-product-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API - Seller Portal — Product. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: vtex-create-product
      description: VTex Create Product
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-api-seller-portal-product.postproduct
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-product-external-id
      description: VTex Get Product by external ID,  SKU ID, SKU external ID or slug
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-product.getproductquery
      with:
        param: tools.param
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-product-id
      description: VTex Get Product by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-product.getproduct
      with:
        productId: tools.productId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-product
      description: VTex Update Product
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-product.putproduct
      with:
        productId: tools.productId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-product-description-product
      description: VTex Get Product Description by Product ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-product.getproductdescription
      with:
        productId: tools.productId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-product-description-product
      description: VTex Update Product Description by Product ID
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-api-seller-portal-product.putproductdescription
      with:
        productId: tools.productId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.