VTex Catalog API — SKU Kit

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — SKU Kit
  description: 'VTex Catalog API — SKU Kit. 5 operations. Lead operation: VTex Get SKU kit by SKU ID or Parent SKU ID. Self-contained
    Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - SKU Kit
  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-kit
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — SKU Kit business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-pvt-stockkeepingunitkit
      path: /api/catalog/pvt/stockkeepingunitkit
      operations:
      - name: get
        method: GET
        description: VTex Get SKU kit by SKU ID or Parent SKU ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: query
          type: integer
          description: SKU's unique numerical identifier.
        - name: parentSkuId
          in: query
          type: integer
          description: Parent SKU's unique numerical identifier.
      - name: post
        method: POST
        description: VTex Create SKU kit
        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 Delete SKU kit by SKU ID or parent SKU ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: skuId
          in: query
          type: integer
          description: SKU's unique numerical identifier.
        - name: parentSkuId
          in: query
          type: integer
          description: Parent SKU's unique numerical identifier.
    - name: api-catalog-pvt-stockkeepingunitkit-kitId
      path: /api/catalog/pvt/stockkeepingunitkit/{kitId}
      operations:
      - name: get
        method: GET
        description: VTex Get SKU kit
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: kitId
          in: path
          type: integer
          description: Kit's unique numerical identifier
          required: true
      - name: delete
        method: DELETE
        description: VTex Delete SKU kit by kit ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: kitId
          in: path
          type: integer
          description: Kit's unique numerical identifier.
          required: true
    authentication:
      type: apikey
      key: X-VTEX-API-AppKey
      value: '{{env.VTEX_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-sku-kit-rest
    port: 8080
    description: REST adapter for VTex Catalog API — SKU Kit. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/api/catalog/pvt/stockkeepingunitkit
      name: api-catalog-pvt-stockkeepingunitkit
      description: REST surface for api-catalog-pvt-stockkeepingunitkit.
      operations:
      - method: GET
        name: get
        description: VTex Get SKU kit by SKU ID or Parent SKU ID
        call: catalog-sku-kit.get
        with:
          skuId: rest.skuId
          parentSkuId: rest.parentSkuId
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: post
        description: VTex Create SKU kit
        call: catalog-sku-kit.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete SKU kit by SKU ID or parent SKU ID
        call: catalog-sku-kit.delete
        with:
          skuId: rest.skuId
          parentSkuId: rest.parentSkuId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/stockkeepingunitkit/{kitid}
      name: api-catalog-pvt-stockkeepingunitkit-kitid
      description: REST surface for api-catalog-pvt-stockkeepingunitkit-kitId.
      operations:
      - method: GET
        name: get
        description: VTex Get SKU kit
        call: catalog-sku-kit.get
        with:
          kitId: rest.kitId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete SKU kit by kit ID
        call: catalog-sku-kit.delete
        with:
          kitId: rest.kitId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-sku-kit-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — SKU Kit. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: vtex-get-sku-kit-sku
      description: VTex Get SKU kit by SKU ID or Parent SKU ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-sku-kit.get
      with:
        skuId: tools.skuId
        parentSkuId: tools.parentSkuId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-sku-kit
      description: VTex Create SKU kit
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-sku-kit.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-sku-kit-sku
      description: VTex Delete SKU kit by SKU ID or parent SKU ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-sku-kit.delete
      with:
        skuId: tools.skuId
        parentSkuId: tools.parentSkuId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-sku-kit
      description: VTex Get SKU kit
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-sku-kit.get
      with:
        kitId: tools.kitId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-sku-kit-kit
      description: VTex Delete SKU kit by kit ID
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-sku-kit.delete
      with:
        kitId: tools.kitId
      outputParameters:
      - type: object
        mapping: $.