BigCommerce Catalog - Categories — Categories (Deprecated)

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Catalog - Categories — Categories (Deprecated)
  description: 'BigCommerce Catalog - Categories — Categories (Deprecated). 6 operations. Lead operation: BigCommerce Get
    All Categories. Self-contained Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Categories (Deprecated)
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-categories-categories-deprecated
    baseUri: https://api.bigcommerce.com/stores/{store_hash}/v3
    description: BigCommerce Catalog - Categories — Categories (Deprecated) business capability. Self-contained, no shared
      references.
    resources:
    - name: catalog-categories
      path: /catalog/categories
      operations:
      - name: getcategories
        method: GET
        description: BigCommerce Get All Categories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: integer
          description: Filter items by ID.
        - name: id:in
          in: query
          type: array
        - name: id:not_in
          in: query
          type: array
        - name: id:min
          in: query
          type: array
        - name: id:max
          in: query
          type: array
        - name: id:greater
          in: query
          type: array
        - name: id:less
          in: query
          type: array
        - name: name
          in: query
          type: string
          description: Filter items by name.
        - name: name:like
          in: query
          type: array
        - name: parent_id
          in: query
          type: integer
          description: Filter items by parent_id. If the category is a child or sub category it can be filtered with the parent_id.
        - name: parent_id:in
          in: query
          type: array
        - name: parent_id:min
          in: query
          type: array
        - name: parent_id:max
          in: query
          type: array
        - name: parent_id:greater
          in: query
          type: array
        - name: parent_id:less
          in: query
          type: array
        - name: page_title
          in: query
          type: string
          description: Filter items by page_title.
        - name: page_title:like
          in: query
          type: array
        - name: keyword
          in: query
          type: string
          description: Filter items by keywords. eg. new, towel, bath
        - name: is_visible
          in: query
          type: boolean
          description: Filter items by if visible on the storefront.
        - name: page
          in: query
          type: integer
          description: Specifies the page number in a limited (paginated) list of products.
        - name: limit
          in: query
          type: integer
          description: Controls the number of items per page in a limited (paginated) list of products.
        - name: include_fields
          in: query
          type: string
          description: Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
        - name: exclude_fields
          in: query
          type: string
          description: Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response.
            The ID cannot be excluded.
        - name: sort
          in: query
          type: string
          description: Controls the sort order of the response, for example, `sort=name`.
      - name: createcategory
        method: POST
        description: BigCommerce Create a Category
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecategories
        method: DELETE
        description: BigCommerce Delete Categories
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: integer
          description: Filter items by ID.
        - name: id:in
          in: query
          type: array
        - name: id:not_in
          in: query
          type: array
        - name: id:min
          in: query
          type: array
        - name: id:max
          in: query
          type: array
        - name: id:greater
          in: query
          type: array
        - name: id:less
          in: query
          type: array
        - name: name
          in: query
          type: string
          description: Filter items by name.
        - name: parent_id
          in: query
          type: integer
          description: Filter items by parent_id. If the category is a child or sub category it can be filtered with the parent_id.
        - name: page_title
          in: query
          type: string
          description: Filter items by page_title.
        - name: keyword
          in: query
          type: string
          description: Filter items by keywords. eg. new, towel, bath
        - name: is_visible
          in: query
          type: boolean
          description: Filter items by if visible on the storefront.
        - name: name:like
          in: query
          type: array
        - name: parent_id:in
          in: query
          type: array
        - name: parent_id:min
          in: query
          type: array
        - name: parent_id:max
          in: query
          type: array
        - name: parent_id:greater
          in: query
          type: array
        - name: parent_id:less
          in: query
          type: array
        - name: page_title:like
          in: query
          type: array
    - name: catalog-categories-category_id
      path: /catalog/categories/{category_id}
      operations:
      - name: getcategory
        method: GET
        description: BigCommerce Get a Category
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: include_fields
          in: query
          type: string
          description: Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
        - name: exclude_fields
          in: query
          type: string
          description: Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response.
            The ID cannot be excluded.
      - name: updatecategory
        method: PUT
        description: BigCommerce Update a Category
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecategory
        method: DELETE
        description: BigCommerce Delete a Category
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.BIGCOMMERCE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: catalog-categories-categories-deprecated-rest
    port: 8080
    description: REST adapter for BigCommerce Catalog - Categories — Categories (Deprecated). One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/catalog/categories
      name: catalog-categories
      description: REST surface for catalog-categories.
      operations:
      - method: GET
        name: getcategories
        description: BigCommerce Get All Categories
        call: catalog-categories-categories-deprecated.getcategories
        with:
          id: rest.id
          id:in: rest.id:in
          id:not_in: rest.id:not_in
          id:min: rest.id:min
          id:max: rest.id:max
          id:greater: rest.id:greater
          id:less: rest.id:less
          name: rest.name
          name:like: rest.name:like
          parent_id: rest.parent_id
          parent_id:in: rest.parent_id:in
          parent_id:min: rest.parent_id:min
          parent_id:max: rest.parent_id:max
          parent_id:greater: rest.parent_id:greater
          parent_id:less: rest.parent_id:less
          page_title: rest.page_title
          page_title:like: rest.page_title:like
          keyword: rest.keyword
          is_visible: rest.is_visible
          page: rest.page
          limit: rest.limit
          include_fields: rest.include_fields
          exclude_fields: rest.exclude_fields
          sort: rest.sort
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcategory
        description: BigCommerce Create a Category
        call: catalog-categories-categories-deprecated.createcategory
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecategories
        description: BigCommerce Delete Categories
        call: catalog-categories-categories-deprecated.deletecategories
        with:
          id: rest.id
          id:in: rest.id:in
          id:not_in: rest.id:not_in
          id:min: rest.id:min
          id:max: rest.id:max
          id:greater: rest.id:greater
          id:less: rest.id:less
          name: rest.name
          parent_id: rest.parent_id
          page_title: rest.page_title
          keyword: rest.keyword
          is_visible: rest.is_visible
          name:like: rest.name:like
          parent_id:in: rest.parent_id:in
          parent_id:min: rest.parent_id:min
          parent_id:max: rest.parent_id:max
          parent_id:greater: rest.parent_id:greater
          parent_id:less: rest.parent_id:less
          page_title:like: rest.page_title:like
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/catalog/categories/{category-id}
      name: catalog-categories-category-id
      description: REST surface for catalog-categories-category_id.
      operations:
      - method: GET
        name: getcategory
        description: BigCommerce Get a Category
        call: catalog-categories-categories-deprecated.getcategory
        with:
          include_fields: rest.include_fields
          exclude_fields: rest.exclude_fields
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecategory
        description: BigCommerce Update a Category
        call: catalog-categories-categories-deprecated.updatecategory
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecategory
        description: BigCommerce Delete a Category
        call: catalog-categories-categories-deprecated.deletecategory
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-categories-categories-deprecated-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Catalog - Categories — Categories (Deprecated). One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: bigcommerce-get-all-categories
      description: BigCommerce Get All Categories
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-categories-categories-deprecated.getcategories
      with:
        id: tools.id
        id:in: tools.id:in
        id:not_in: tools.id:not_in
        id:min: tools.id:min
        id:max: tools.id:max
        id:greater: tools.id:greater
        id:less: tools.id:less
        name: tools.name
        name:like: tools.name:like
        parent_id: tools.parent_id
        parent_id:in: tools.parent_id:in
        parent_id:min: tools.parent_id:min
        parent_id:max: tools.parent_id:max
        parent_id:greater: tools.parent_id:greater
        parent_id:less: tools.parent_id:less
        page_title: tools.page_title
        page_title:like: tools.page_title:like
        keyword: tools.keyword
        is_visible: tools.is_visible
        page: tools.page
        limit: tools.limit
        include_fields: tools.include_fields
        exclude_fields: tools.exclude_fields
        sort: tools.sort
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-create-category
      description: BigCommerce Create a Category
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-categories-categories-deprecated.createcategory
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-categories
      description: BigCommerce Delete Categories
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-categories-categories-deprecated.deletecategories
      with:
        id: tools.id
        id:in: tools.id:in
        id:not_in: tools.id:not_in
        id:min: tools.id:min
        id:max: tools.id:max
        id:greater: tools.id:greater
        id:less: tools.id:less
        name: tools.name
        parent_id: tools.parent_id
        page_title: tools.page_title
        keyword: tools.keyword
        is_visible: tools.is_visible
        name:like: tools.name:like
        parent_id:in: tools.parent_id:in
        parent_id:min: tools.parent_id:min
        parent_id:max: tools.parent_id:max
        parent_id:greater: tools.parent_id:greater
        parent_id:less: tools.parent_id:less
        page_title:like: tools.page_title:like
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-get-category
      description: BigCommerce Get a Category
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-categories-categories-deprecated.getcategory
      with:
        include_fields: tools.include_fields
        exclude_fields: tools.exclude_fields
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-update-category
      description: BigCommerce Update a Category
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-categories-categories-deprecated.updatecategory
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-category
      description: BigCommerce Delete a Category
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-categories-categories-deprecated.deletecategory
      outputParameters:
      - type: object
        mapping: $.