VTex Catalog API — Legacy Subcollection

naftiko: 1.0.0-alpha2
info:
  label: VTex Catalog API — Legacy Subcollection
  description: 'VTex Catalog API — Legacy Subcollection. 12 operations. Lead operation: VTex Reposition SKU on the subcollection.
    Self-contained Naftiko capability covering one Vtex business surface.'
  tags:
  - Vtex
  - Legacy Subcollection
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    VTEX_API_KEY: VTEX_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-legacy-subcollection
    baseUri: https://{accountName}.{environment}.com.br
    description: VTex Catalog API — Legacy Subcollection business capability. Self-contained, no shared references.
    resources:
    - name: api-catalog-pvt-collection-collectionId-position
      path: /api/catalog/pvt/collection/{collectionId}/position
      operations:
      - name: post
        method: POST
        description: VTex Reposition SKU on the subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collectionId
          in: path
          type: integer
          description: Collection's unique numerical identifier.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog-pvt-collection-collectionId-subcollection
      path: /api/catalog/pvt/collection/{collectionId}/subcollection
      operations:
      - name: get
        method: GET
        description: VTex Get subcollection by collection ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: collectionId
          in: path
          type: integer
          description: Collection's unique numerical identifier.
          required: true
    - name: api-catalog-pvt-subcollection
      path: /api/catalog/pvt/subcollection
      operations:
      - name: post
        method: POST
        description: VTex Create subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog-pvt-subcollection-subCollectionId
      path: /api/catalog/pvt/subcollection/{subCollectionId}
      operations:
      - name: get
        method: GET
        description: VTex Get subcollection by subcollection ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subCollectionId
          in: path
          type: integer
          description: Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection
            by collection ID](https://developers.vtex.com/vtex
          required: true
      - name: put
        method: PUT
        description: VTex Update subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subCollectionId
          in: path
          type: integer
          description: Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection
            by collection ID](https://developers.vtex.com/vtex
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: delete
        method: DELETE
        description: VTex Delete subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subCollectionId
          in: path
          type: integer
          description: Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection
            by collection ID](https://developers.vtex.com/vtex
          required: true
    - name: api-catalog-pvt-subcollection-subCollectionId-brand
      path: /api/catalog/pvt/subcollection/{subCollectionId}/brand
      operations:
      - name: post
        method: POST
        description: VTex Associate brand to subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subCollectionId
          in: path
          type: integer
          description: Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection
            by collection ID](https://developers.vtex.com/vtex
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog-pvt-subcollection-subCollectionId-brand-brandId
      path: /api/catalog/pvt/subcollection/{subCollectionId}/brand/{brandId}
      operations:
      - name: delete
        method: DELETE
        description: VTex Delete brand from subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subCollectionId
          in: path
          type: integer
          description: Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection
            by collection ID](https://developers.vtex.com/vtex
          required: true
        - name: brandId
          in: path
          type: integer
          description: Brand's unique numerical identifier.
          required: true
    - name: api-catalog-pvt-subcollection-subCollectionId-brand-categoryId
      path: /api/catalog/pvt/subcollection/{subCollectionId}/brand/{categoryId}
      operations:
      - name: delete
        method: DELETE
        description: VTex Delete category from Subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subCollectionId
          in: path
          type: integer
          description: Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection
            by dollection ID](https://developers.vtex.com/vtex
          required: true
        - name: categoryId
          in: path
          type: integer
          description: Category's unique numerical identifier.
          required: true
    - name: api-catalog-pvt-subcollection-subCollectionId-category
      path: /api/catalog/pvt/subcollection/{subCollectionId}/category
      operations:
      - name: post
        method: POST
        description: VTex Associate category to subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subCollectionId
          in: path
          type: integer
          description: Subcollection's unique numerical identifier, which can be obtained by placing a request to [Get subcollection
            by collection ID](https://developers.vtex.com/vtex
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog-pvt-subcollection-subCollectionId-stockkeepingunit
      path: /api/catalog/pvt/subcollection/{subCollectionId}/stockkeepingunit
      operations:
      - name: post
        method: POST
        description: VTex Add SKU to subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subCollectionId
          in: path
          type: integer
          description: Subcollection'''s unique numerical identifier, which can be obtained by placing a request to [Get subcollection
            by collection ID](https://developers.vtex.com/vt
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-catalog-pvt-subcollection-subCollectionId-stockkeepingunit-skuId
      path: /api/catalog/pvt/subcollection/{subCollectionId}/stockkeepingunit/{skuId}
      operations:
      - name: delete
        method: DELETE
        description: VTex Delete SKU from subcollection
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subCollectionId
          in: path
          type: integer
          description: Subcollection'''s unique numerical identifier, which can be obtained by placing a request to [Get subcollection
            by collection ID](https://developers.vtex.com/vt
          required: true
        - name: skuId
          in: path
          type: integer
          description: SKU'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-legacy-subcollection-rest
    port: 8080
    description: REST adapter for VTex Catalog API — Legacy Subcollection. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/catalog/pvt/collection/{collectionid}/position
      name: api-catalog-pvt-collection-collectionid-position
      description: REST surface for api-catalog-pvt-collection-collectionId-position.
      operations:
      - method: POST
        name: post
        description: VTex Reposition SKU on the subcollection
        call: catalog-legacy-subcollection.post
        with:
          collectionId: rest.collectionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/collection/{collectionid}/subcollection
      name: api-catalog-pvt-collection-collectionid-subcollection
      description: REST surface for api-catalog-pvt-collection-collectionId-subcollection.
      operations:
      - method: GET
        name: get
        description: VTex Get subcollection by collection ID
        call: catalog-legacy-subcollection.get
        with:
          collectionId: rest.collectionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/subcollection
      name: api-catalog-pvt-subcollection
      description: REST surface for api-catalog-pvt-subcollection.
      operations:
      - method: POST
        name: post
        description: VTex Create subcollection
        call: catalog-legacy-subcollection.post
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/subcollection/{subcollectionid}
      name: api-catalog-pvt-subcollection-subcollectionid
      description: REST surface for api-catalog-pvt-subcollection-subCollectionId.
      operations:
      - method: GET
        name: get
        description: VTex Get subcollection by subcollection ID
        call: catalog-legacy-subcollection.get
        with:
          subCollectionId: rest.subCollectionId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: put
        description: VTex Update subcollection
        call: catalog-legacy-subcollection.put
        with:
          subCollectionId: rest.subCollectionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: delete
        description: VTex Delete subcollection
        call: catalog-legacy-subcollection.delete
        with:
          subCollectionId: rest.subCollectionId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/subcollection/{subcollectionid}/brand
      name: api-catalog-pvt-subcollection-subcollectionid-brand
      description: REST surface for api-catalog-pvt-subcollection-subCollectionId-brand.
      operations:
      - method: POST
        name: post
        description: VTex Associate brand to subcollection
        call: catalog-legacy-subcollection.post
        with:
          subCollectionId: rest.subCollectionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/subcollection/{subcollectionid}/brand/{brandid}
      name: api-catalog-pvt-subcollection-subcollectionid-brand-brandid
      description: REST surface for api-catalog-pvt-subcollection-subCollectionId-brand-brandId.
      operations:
      - method: DELETE
        name: delete
        description: VTex Delete brand from subcollection
        call: catalog-legacy-subcollection.delete
        with:
          subCollectionId: rest.subCollectionId
          brandId: rest.brandId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/subcollection/{subcollectionid}/brand/{categoryid}
      name: api-catalog-pvt-subcollection-subcollectionid-brand-categoryid
      description: REST surface for api-catalog-pvt-subcollection-subCollectionId-brand-categoryId.
      operations:
      - method: DELETE
        name: delete
        description: VTex Delete category from Subcollection
        call: catalog-legacy-subcollection.delete
        with:
          subCollectionId: rest.subCollectionId
          categoryId: rest.categoryId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/subcollection/{subcollectionid}/category
      name: api-catalog-pvt-subcollection-subcollectionid-category
      description: REST surface for api-catalog-pvt-subcollection-subCollectionId-category.
      operations:
      - method: POST
        name: post
        description: VTex Associate category to subcollection
        call: catalog-legacy-subcollection.post
        with:
          subCollectionId: rest.subCollectionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/subcollection/{subcollectionid}/stockkeepingunit
      name: api-catalog-pvt-subcollection-subcollectionid-stockkeepingunit
      description: REST surface for api-catalog-pvt-subcollection-subCollectionId-stockkeepingunit.
      operations:
      - method: POST
        name: post
        description: VTex Add SKU to subcollection
        call: catalog-legacy-subcollection.post
        with:
          subCollectionId: rest.subCollectionId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/catalog/pvt/subcollection/{subcollectionid}/stockkeepingunit/{skuid}
      name: api-catalog-pvt-subcollection-subcollectionid-stockkeepingunit-skuid
      description: REST surface for api-catalog-pvt-subcollection-subCollectionId-stockkeepingunit-skuId.
      operations:
      - method: DELETE
        name: delete
        description: VTex Delete SKU from subcollection
        call: catalog-legacy-subcollection.delete
        with:
          subCollectionId: rest.subCollectionId
          skuId: rest.skuId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-legacy-subcollection-mcp
    port: 9090
    transport: http
    description: MCP adapter for VTex Catalog API — Legacy Subcollection. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: vtex-reposition-sku-subcollection
      description: VTex Reposition SKU on the subcollection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-legacy-subcollection.post
      with:
        collectionId: tools.collectionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-subcollection-collection-id
      description: VTex Get subcollection by collection ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-legacy-subcollection.get
      with:
        collectionId: tools.collectionId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-create-subcollection
      description: VTex Create subcollection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-legacy-subcollection.post
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-get-subcollection-subcollection-id
      description: VTex Get subcollection by subcollection ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-legacy-subcollection.get
      with:
        subCollectionId: tools.subCollectionId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-update-subcollection
      description: VTex Update subcollection
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-legacy-subcollection.put
      with:
        subCollectionId: tools.subCollectionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-subcollection
      description: VTex Delete subcollection
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-legacy-subcollection.delete
      with:
        subCollectionId: tools.subCollectionId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-associate-brand-subcollection
      description: VTex Associate brand to subcollection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-legacy-subcollection.post
      with:
        subCollectionId: tools.subCollectionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-brand-subcollection
      description: VTex Delete brand from subcollection
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-legacy-subcollection.delete
      with:
        subCollectionId: tools.subCollectionId
        brandId: tools.brandId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-category-subcollection
      description: VTex Delete category from Subcollection
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-legacy-subcollection.delete
      with:
        subCollectionId: tools.subCollectionId
        categoryId: tools.categoryId
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-associate-category-subcollection
      description: VTex Associate category to subcollection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-legacy-subcollection.post
      with:
        subCollectionId: tools.subCollectionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-add-sku-subcollection
      description: VTex Add SKU to subcollection
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-legacy-subcollection.post
      with:
        subCollectionId: tools.subCollectionId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: vtex-delete-sku-subcollection
      description: VTex Delete SKU from subcollection
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-legacy-subcollection.delete
      with:
        subCollectionId: tools.subCollectionId
        skuId: tools.skuId
      outputParameters:
      - type: object
        mapping: $.