VTex Catalog API — SKU Attachment

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — SKU Attachment
  description: 'VTex Catalog API — SKU Attachment. 5 operations. Lead operation: VTex Associate SKU attachment. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - SKU Attachment
  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-attachment
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — SKU Attachment business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-pvt-skuattachment
      path: /api/catalog/pvt/skuattachment
      operations:
      - name: post
        method: POST
        description: VTex Associate SKU attachment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: VTex Dissociate attachments and SKUs
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: query
          type: integer
          description: SKU ID. By using this query param, you can dissociate all the attachments from an SKU based on its
            SKU ID.
        - name: attachmentId
          in: query
          type: integer
          description: Attachment ID. By using this query param, you can dissociate the given attachment from all previously
            associated SKUs.
    - name: api-catalog-pvt-skuattachment-skuAttachmentAssociationId
      path: /api/catalog/pvt/skuattachment/{skuAttachmentAssociationId}
      operations:
      - name: delete
        method: DELETE
        description: VTex Delete SKU attachment by attachment association ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuAttachmentAssociationId
          in: path
          type: integer
          description: ID of the association between the attachment and the SKU, which corresponds to the `Id` in the response
            body of the [Associate SKU attachment](https://developer
          required: true
    - name: api-catalog-pvt-stockkeepingunit-skuId-attachment
      path: /api/catalog/pvt/stockkeepingunit/{skuId}/attachment
      operations:
      - name: get
        method: GET
        description: VTex Get SKU attachments by SKU ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: path
          type: integer
          description: SKU unique identifier.
          required: true
    - name: api-catalog_system-pvt-sku-associateattachments
      path: /api/catalog_system/pvt/sku/associateattachments
      operations:
      - name: associateattachmentstosku
        method: POST
        description: VTex Associate attachments to an SKU
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - 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-sku-attachment-rest
    port: 8080
    description: REST adapter for VTex Catalog API — SKU Attachment. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/catalog/pvt/skuattachment
      name: api-catalog-pvt-skuattachment
      description: REST surface for api-catalog-pvt-skuattachment.
      operations:
      - method: POST
        name: post
        description: VTex Associate SKU attachment
        call: catalog-sku-attachment.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Dissociate attachments and SKUs
        call: catalog-sku-attachment.delete
        with:
          skuId: rest.skuId
          attachmentId: rest.attachmentId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/skuattachment/{skuattachmentassociationid}
      name: api-catalog-pvt-skuattachment-skuattachmentassociationid
      description: REST surface for api-catalog-pvt-skuattachment-skuAttachmentAssociationId.
      operations:
      - method: DELETE
        name: delete
        description: VTex Delete SKU attachment by attachment association ID
        call: catalog-sku-attachment.delete
        with:
          skuAttachmentAssociationId: rest.skuAttachmentAssociationId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/stockkeepingunit/{skuid}/attachment
      name: api-catalog-pvt-stockkeepingunit-skuid-attachment
      description: REST surface for api-catalog-pvt-stockkeepingunit-skuId-attachment.
      operations:
      - method: GET
        name: get
        description: VTex Get SKU attachments by SKU ID
        call: catalog-sku-attachment.get
        with:
          skuId: rest.skuId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog-system/pvt/sku/associateattachments
      name: api-catalog-system-pvt-sku-associateattachments
      description: REST surface for api-catalog_system-pvt-sku-associateattachments.
      operations:
      - method: POST
        name: associateattachmentstosku
        description: VTex Associate attachments to an SKU
        call: catalog-sku-attachment.associateattachmentstosku
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-sku-attachment-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — SKU Attachment. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-associate-sku-attachment
      description: VTex Associate SKU attachment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-sku-attachment.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-dissociate-attachments-and-skus
      description: VTex Dissociate attachments and SKUs
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-sku-attachment.delete
      with:
        skuId: tools.skuId
        attachmentId: tools.attachmentId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-sku-attachment-attachment
      description: VTex Delete SKU attachment by attachment association ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-sku-attachment.delete
      with:
        skuAttachmentAssociationId: tools.skuAttachmentAssociationId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-sku-attachments-sku
      description: VTex Get SKU attachments by SKU ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-sku-attachment.get
      with:
        skuId: tools.skuId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-associate-attachments-sku
      description: VTex Associate attachments to an SKU
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-sku-attachment.associateattachmentstosku
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.