BigCommerce Custom Template Associations — Custom Template Associations

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Custom Template Associations — Custom Template Associations
  description: 'BigCommerce Custom Template Associations — Custom Template Associations. 3 operations. Lead operation: BigCommerce
    Get Custom Template Associations. Self-contained Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Custom Template Associations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: custom-template-associations-custom-template-associations
    baseUri: https://api.bigcommerce.com/stores/{store_hash}/v3
    description: BigCommerce Custom Template Associations — Custom Template Associations business capability. Self-contained,
      no shared references.
    resources:
    - name: storefront-custom-template-associations
      path: /storefront/custom-template-associations
      operations:
      - name: getcustomtemplateassociations
        method: GET
        description: BigCommerce Get Custom Template Associations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: channel_id
          in: query
          type: integer
          description: Channel ID to return only custom template associations for a given Channel
        - name: entity_id:in
          in: query
          type: string
          description: Filter by a list of entity IDs. Must be used together with "type" filter.
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page
        - name: page
          in: query
          type: integer
          description: Which page number to return, based on the page size. Used to paginate large collections.
        - name: type
          in: query
          type: string
          description: Filter associations by type
        - name: is_valid
          in: query
          type: boolean
          description: Optional toggle to filter for exclusively valid or invalid associations entries. An invalid entry is
            one where its file name does not match up to an existing cu
      - name: upsertcustomtemplateassociations
        method: PUT
        description: BigCommerce Upsert Custom Template Associations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
      - name: deletecustomtemplateassociations
        method: DELETE
        description: BigCommerce Delete Custom Template Associations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id:in
          in: query
          type: integer
          description: List of Association IDs to delete explicitly.
        - name: entity_id:in
          in: query
          type: integer
          description: List of Entity IDs to delete explicitly. Must be used together with "type"
        - name: channel_id
          in: query
          type: integer
          description: Channel ID provided to delete all custom template associations for a given Channel
        - name: type
          in: query
          type: string
          description: Filter associations by type
    authentication:
      type: apikey
      key: X-Auth-Token
      value: '{{env.BIGCOMMERCE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: custom-template-associations-custom-template-associations-rest
    port: 8080
    description: REST adapter for BigCommerce Custom Template Associations — Custom Template Associations. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/storefront/custom-template-associations
      name: storefront-custom-template-associations
      description: REST surface for storefront-custom-template-associations.
      operations:
      - method: GET
        name: getcustomtemplateassociations
        description: BigCommerce Get Custom Template Associations
        call: custom-template-associations-custom-template-associations.getcustomtemplateassociations
        with:
          channel_id: rest.channel_id
          entity_id:in: rest.entity_id:in
          limit: rest.limit
          page: rest.page
          type: rest.type
          is_valid: rest.is_valid
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: upsertcustomtemplateassociations
        description: BigCommerce Upsert Custom Template Associations
        call: custom-template-associations-custom-template-associations.upsertcustomtemplateassociations
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecustomtemplateassociations
        description: BigCommerce Delete Custom Template Associations
        call: custom-template-associations-custom-template-associations.deletecustomtemplateassociations
        with:
          id:in: rest.id:in
          entity_id:in: rest.entity_id:in
          channel_id: rest.channel_id
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: custom-template-associations-custom-template-associations-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Custom Template Associations — Custom Template Associations. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: bigcommerce-get-custom-template-associations
      description: BigCommerce Get Custom Template Associations
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: custom-template-associations-custom-template-associations.getcustomtemplateassociations
      with:
        channel_id: tools.channel_id
        entity_id:in: tools.entity_id:in
        limit: tools.limit
        page: tools.page
        type: tools.type
        is_valid: tools.is_valid
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-upsert-custom-template-associations
      description: BigCommerce Upsert Custom Template Associations
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: custom-template-associations-custom-template-associations.upsertcustomtemplateassociations
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-custom-template-associations
      description: BigCommerce Delete Custom Template Associations
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: custom-template-associations-custom-template-associations.deletecustomtemplateassociations
      with:
        id:in: tools.id:in
        entity_id:in: tools.entity_id:in
        channel_id: tools.channel_id
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.