BigCommerce Marketing — Banners

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Marketing — Banners
  description: 'BigCommerce Marketing — Banners. 7 operations. Lead operation: BigCommerce Get All Banners. Self-contained
    Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Banners
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: marketing-banners
    baseUri: https://api.bigcommerce.com/stores/{store_hash}/v2
    description: BigCommerce Marketing — Banners business capability. Self-contained, no shared references.
    resources:
    - name: banners
      path: /banners
      operations:
      - name: getbanners
        method: GET
        description: BigCommerce Get All Banners
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: min_id
          in: query
          type: integer
          description: Optional filter param `/api/v2/banners?min_id={value}`
        - name: max_id
          in: query
          type: integer
          description: Optional filter param `/api/v2/banners?max_id={value}`
        - name: page
          in: query
          type: number
          description: Optional filter param `/api/v2/banners?page={number}`
        - name: limit
          in: query
          type: number
          description: Optional filter param `/api/v2/banners?limit={count}`
      - name: createbanner
        method: POST
        description: BigCommerce Create a Banner
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletebanners
        method: DELETE
        description: BigCommerce Delete All Banners
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: banners-count
      path: /banners/count
      operations:
      - name: getbannerscount
        method: GET
        description: BigCommerce Get a Count of Store Banners
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: banners-id
      path: /banners/{id}
      operations:
      - name: getbanner
        method: GET
        description: BigCommerce Get a Banner
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatebanner
        method: PUT
        description: BigCommerce Update a Banner
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletebanner
        method: DELETE
        description: BigCommerce Delete a Banner
        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: marketing-banners-rest
    port: 8080
    description: REST adapter for BigCommerce Marketing — Banners. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/banners
      name: banners
      description: REST surface for banners.
      operations:
      - method: GET
        name: getbanners
        description: BigCommerce Get All Banners
        call: marketing-banners.getbanners
        with:
          min_id: rest.min_id
          max_id: rest.max_id
          page: rest.page
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createbanner
        description: BigCommerce Create a Banner
        call: marketing-banners.createbanner
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebanners
        description: BigCommerce Delete All Banners
        call: marketing-banners.deletebanners
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/banners/count
      name: banners-count
      description: REST surface for banners-count.
      operations:
      - method: GET
        name: getbannerscount
        description: BigCommerce Get a Count of Store Banners
        call: marketing-banners.getbannerscount
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/banners/{id}
      name: banners-id
      description: REST surface for banners-id.
      operations:
      - method: GET
        name: getbanner
        description: BigCommerce Get a Banner
        call: marketing-banners.getbanner
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatebanner
        description: BigCommerce Update a Banner
        call: marketing-banners.updatebanner
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletebanner
        description: BigCommerce Delete a Banner
        call: marketing-banners.deletebanner
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketing-banners-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Marketing — Banners. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: bigcommerce-get-all-banners
      description: BigCommerce Get All Banners
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketing-banners.getbanners
      with:
        min_id: tools.min_id
        max_id: tools.max_id
        page: tools.page
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-create-banner
      description: BigCommerce Create a Banner
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketing-banners.createbanner
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-all-banners
      description: BigCommerce Delete All Banners
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: marketing-banners.deletebanners
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-get-count-store-banners
      description: BigCommerce Get a Count of Store Banners
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketing-banners.getbannerscount
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-get-banner
      description: BigCommerce Get a Banner
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketing-banners.getbanner
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-update-banner
      description: BigCommerce Update a Banner
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: marketing-banners.updatebanner
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-banner
      description: BigCommerce Delete a Banner
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: marketing-banners.deletebanner
      outputParameters:
      - type: object
        mapping: $.