BigCommerce Catalog - Brands — Brands

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Catalog - Brands — Brands
  description: 'BigCommerce Catalog - Brands — Brands. 6 operations. Lead operation: BigCommerce Get All Brands. Self-contained
    Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Brands
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: catalog-brands-brands
    baseUri: https://api.bigcommerce.com/stores/{store_hash}/v3
    description: BigCommerce Catalog - Brands — Brands business capability. Self-contained, no shared references.
    resources:
    - name: catalog-brands
      path: /catalog/brands
      operations:
      - name: getbrands
        method: GET
        description: BigCommerce Get All Brands
        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: name
          in: query
          type: string
          description: Filter items by name.
        - name: name:like
          in: query
          type: string
          description: Filter items by part of a name. For example, `name:like=new` returns brands with names that include
            `new`.
        - name: page_title
          in: query
          type: string
          description: Filter items by page_title.
        - 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: Field name to sort by.
      - name: createbrand
        method: POST
        description: BigCommerce Create a Brand
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletebrands
        method: DELETE
        description: BigCommerce Delete Brands
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: Filter items by name.
          required: true
        - name: page_title
          in: query
          type: string
          description: Filter items by page_title.
    - name: catalog-brands-brand_id
      path: /catalog/brands/{brand_id}
      operations:
      - name: getbrand
        method: GET
        description: BigCommerce Get a Brand
        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: updatebrand
        method: PUT
        description: BigCommerce Update a Brand
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletebrand
        method: DELETE
        description: BigCommerce Delete a Brand
        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-brands-brands-rest
    port: 8080
    description: REST adapter for BigCommerce Catalog - Brands — Brands. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/catalog/brands
      name: catalog-brands
      description: REST surface for catalog-brands.
      operations:
      - method: GET
        name: getbrands
        description: BigCommerce Get All Brands
        call: catalog-brands-brands.getbrands
        with:
          id: rest.id
          id:in: rest.id:in
          id:not_in: rest.id:not_in
          name: rest.name
          name:like: rest.name:like
          page_title: rest.page_title
          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: createbrand
        description: BigCommerce Create a Brand
        call: catalog-brands-brands.createbrand
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebrands
        description: BigCommerce Delete Brands
        call: catalog-brands-brands.deletebrands
        with:
          name: rest.name
          page_title: rest.page_title
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/catalog/brands/{brand-id}
      name: catalog-brands-brand-id
      description: REST surface for catalog-brands-brand_id.
      operations:
      - method: GET
        name: getbrand
        description: BigCommerce Get a Brand
        call: catalog-brands-brands.getbrand
        with:
          include_fields: rest.include_fields
          exclude_fields: rest.exclude_fields
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatebrand
        description: BigCommerce Update a Brand
        call: catalog-brands-brands.updatebrand
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebrand
        description: BigCommerce Delete a Brand
        call: catalog-brands-brands.deletebrand
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: catalog-brands-brands-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Catalog - Brands — Brands. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: bigcommerce-get-all-brands
      description: BigCommerce Get All Brands
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-brands-brands.getbrands
      with:
        id: tools.id
        id:in: tools.id:in
        id:not_in: tools.id:not_in
        name: tools.name
        name:like: tools.name:like
        page_title: tools.page_title
        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-brand
      description: BigCommerce Create a Brand
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: catalog-brands-brands.createbrand
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-brands
      description: BigCommerce Delete Brands
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-brands-brands.deletebrands
      with:
        name: tools.name
        page_title: tools.page_title
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-get-brand
      description: BigCommerce Get a Brand
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: catalog-brands-brands.getbrand
      with:
        include_fields: tools.include_fields
        exclude_fields: tools.exclude_fields
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-update-brand
      description: BigCommerce Update a Brand
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: catalog-brands-brands.updatebrand
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-brand
      description: BigCommerce Delete a Brand
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: catalog-brands-brands.deletebrand
      outputParameters:
      - type: object
        mapping: $.