BigCommerce Catalog - Category Trees — Category Trees

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Catalog - Category Trees — Category Trees
  description: 'BigCommerce Catalog - Category Trees — Category Trees. 4 operations. Lead operation: BigCommerce Get All Category
    Trees. Self-contained Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Category Trees
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-category-trees-category-trees
    baseUri: https://api.bigcommerce.com/stores/{store_hash}/v3
    description: BigCommerce Catalog - Category Trees — Category Trees business capability. Self-contained, no shared references.
    resources:
    - name: catalog-trees
      path: /catalog/trees
      operations:
      - name: getcategorytrees
        method: GET
        description: BigCommerce Get All Category Trees
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id:in
          in: query
          type: string
        - name: channel_id:in
          in: query
          type: string
      - name: upsertcategorytrees
        method: PUT
        description: BigCommerce Upsert Category Trees
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecategorytrees
        method: DELETE
        description: BigCommerce Delete Category Trees
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id:in
          in: query
          type: string
    - name: catalog-trees-tree_id-categories
      path: /catalog/trees/{tree_id}/categories
      operations:
      - name: getcategorytree
        method: GET
        description: BigCommerce Get a Category Tree
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: depth
          in: query
          type: integer
          description: Max depth for a tree of categories.
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.BIGCOMMERCE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-category-trees-category-trees-rest
    port: 8080
    description: REST adapter for BigCommerce Catalog - Category Trees — Category Trees. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/catalog/trees
      name: catalog-trees
      description: REST surface for catalog-trees.
      operations:
      - method: GET
        name: getcategorytrees
        description: BigCommerce Get All Category Trees
        call: catalog-category-trees-category-trees.getcategorytrees
        with:
          id:in: rest.id:in
          channel_id:in: rest.channel_id:in
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: upsertcategorytrees
        description: BigCommerce Upsert Category Trees
        call: catalog-category-trees-category-trees.upsertcategorytrees
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecategorytrees
        description: BigCommerce Delete Category Trees
        call: catalog-category-trees-category-trees.deletecategorytrees
        with:
          id:in: rest.id:in
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/catalog/trees/{tree-id}/categories
      name: catalog-trees-tree-id-categories
      description: REST surface for catalog-trees-tree_id-categories.
      operations:
      - method: GET
        name: getcategorytree
        description: BigCommerce Get a Category Tree
        call: catalog-category-trees-category-trees.getcategorytree
        with:
          depth: rest.depth
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-category-trees-category-trees-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Catalog - Category Trees — Category Trees. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: bigcommerce-get-all-category-trees
      description: BigCommerce Get All Category Trees
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-category-trees-category-trees.getcategorytrees
      with:
        id:in: tools.id:in
        channel_id:in: tools.channel_id:in
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-upsert-category-trees
      description: BigCommerce Upsert Category Trees
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-category-trees-category-trees.upsertcategorytrees
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-category-trees
      description: BigCommerce Delete Category Trees
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-category-trees-category-trees.deletecategorytrees
      with:
        id:in: tools.id:in
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-get-category-tree
      description: BigCommerce Get a Category Tree
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-category-trees-category-trees.getcategorytree
      with:
        depth: tools.depth
      outputParameters:
      - type: object
        mapping: $.