VTex Catalog API — SKU File

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — SKU File
  description: 'VTex Catalog API — SKU File. 7 operations. Lead operation: VTex Copy files from an SKU to another SKU. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - SKU File
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-sku-file
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — SKU File business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-pvt-stockkeepingunit-copy-skuIdfrom-skuIdto-file
      path: /api/catalog/pvt/stockkeepingunit/copy/{skuIdfrom}/{skuIdto}/file
      operations:
      - name: put
        method: PUT
        description: VTex Copy files from an SKU to another SKU
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuIdfrom
          in: path
          type: integer
          description: __Origin__ SKU's unique numerical identifier.
          required: true
        - name: skuIdto
          in: path
          type: integer
          description: __Target__ SKU's unique numerical identifier.
          required: true
    - name: api-catalog-pvt-stockkeepingunit-disassociate-skuId-file-skuFileId
      path: /api/catalog/pvt/stockkeepingunit/disassociate/{skuId}/file/{skuFileId}
      operations:
      - name: delete
        method: DELETE
        description: VTex Disassociate SKU file
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
        - name: skuFileId
          in: path
          type: integer
          description: ID of the association of the SKU and the image, which can be obtained by placing a request to the [Get
            SKU file](https://developers.vtex.com/vtex-rest-api/refer
          required: true
    - name: api-catalog-pvt-stockkeepingunit-skuId-file
      path: /api/catalog/pvt/stockkeepingunit/{skuId}/file
      operations:
      - name: get
        method: GET
        description: VTex Get SKU files
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
      - name: post
        method: POST
        description: VTex Create SKU file
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: VTex Delete all SKU files
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
    - name: api-catalog-pvt-stockkeepingunit-skuId-file-skuFileId
      path: /api/catalog/pvt/stockkeepingunit/{skuId}/file/{skuFileId}
      operations:
      - name: put
        method: PUT
        description: VTex Update SKU file
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
        - name: skuFileId
          in: path
          type: integer
          description: ID of the association of the SKU and the image, which can be obtained by placing a request to the [Get
            SKU file](https://developers.vtex.com/vtex-rest-api/refer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: VTex Delete SKU image file
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU's unique numerical identifier.
          required: true
        - name: skuFileId
          in: path
          type: integer
          description: ID of the association of the SKU and the image, which can be obtained by placing a request to the [Get
            SKU file](https://developers.vtex.com/vtex-rest-api/refer
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-sku-file-rest
    port: 8080
    description: REST adapter for VTex Catalog API — SKU File. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/catalog/pvt/stockkeepingunit/copy/{skuidfrom}/{skuidto}/file
      name: api-catalog-pvt-stockkeepingunit-copy-skuidfrom-skuidto-file
      description: REST surface for api-catalog-pvt-stockkeepingunit-copy-skuIdfrom-skuIdto-file.
      operations:
      - method: PUT
        name: put
        description: VTex Copy files from an SKU to another SKU
        call: catalog-sku-file.put
        with:
          skuIdfrom: rest.skuIdfrom
          skuIdto: rest.skuIdto
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/stockkeepingunit/disassociate/{skuid}/file/{skufileid}
      name: api-catalog-pvt-stockkeepingunit-disassociate-skuid-file-skufileid
      description: REST surface for api-catalog-pvt-stockkeepingunit-disassociate-skuId-file-skuFileId.
      operations:
      - method: DELETE
        name: delete
        description: VTex Disassociate SKU file
        call: catalog-sku-file.delete
        with:
          skuId: rest.skuId
          skuFileId: rest.skuFileId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/stockkeepingunit/{skuid}/file
      name: api-catalog-pvt-stockkeepingunit-skuid-file
      description: REST surface for api-catalog-pvt-stockkeepingunit-skuId-file.
      operations:
      - method: GET
        name: get
        description: VTex Get SKU files
        call: catalog-sku-file.get
        with:
          skuId: rest.skuId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: VTex Create SKU file
        call: catalog-sku-file.post
        with:
          skuId: rest.skuId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete all SKU files
        call: catalog-sku-file.delete
        with:
          skuId: rest.skuId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/stockkeepingunit/{skuid}/file/{skufileid}
      name: api-catalog-pvt-stockkeepingunit-skuid-file-skufileid
      description: REST surface for api-catalog-pvt-stockkeepingunit-skuId-file-skuFileId.
      operations:
      - method: PUT
        name: put
        description: VTex Update SKU file
        call: catalog-sku-file.put
        with:
          skuId: rest.skuId
          skuFileId: rest.skuFileId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete SKU image file
        call: catalog-sku-file.delete
        with:
          skuId: rest.skuId
          skuFileId: rest.skuFileId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-sku-file-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — SKU File. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: vtex-copy-files-sku-another
      description: VTex Copy files from an SKU to another SKU
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-sku-file.put
      with:
        skuIdfrom: tools.skuIdfrom
        skuIdto: tools.skuIdto
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-disassociate-sku-file
      description: VTex Disassociate SKU file
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-sku-file.delete
      with:
        skuId: tools.skuId
        skuFileId: tools.skuFileId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-sku-files
      description: VTex Get SKU files
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-sku-file.get
      with:
        skuId: tools.skuId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-sku-file
      description: VTex Create SKU file
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-sku-file.post
      with:
        skuId: tools.skuId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-all-sku-files
      description: VTex Delete all SKU files
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-sku-file.delete
      with:
        skuId: tools.skuId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-sku-file
      description: VTex Update SKU file
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-sku-file.put
      with:
        skuId: tools.skuId
        skuFileId: tools.skuFileId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-sku-image-file
      description: VTex Delete SKU image file
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-sku-file.delete
      with:
        skuId: tools.skuId
        skuFileId: tools.skuFileId
      outputParameters:
      - type: object
        mapping: $.