BigCommerce Marketing — Coupons

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Marketing — Coupons
  description: 'BigCommerce Marketing — Coupons. 6 operations. Lead operation: BigCommerce Get All Coupons. Self-contained
    Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Coupons
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: marketing-coupons
    baseUri: https://api.bigcommerce.com/stores/{store_hash}/v2
    description: BigCommerce Marketing — Coupons business capability. Self-contained, no shared references.
    resources:
    - name: coupons
      path: /coupons
      operations:
      - name: getcoupons
        method: GET
        description: BigCommerce Get All Coupons
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: query
          type: string
          description: Optional filter param. `/api/v2/coupons?id={value}`
        - name: code
          in: query
          type: string
          description: Optional filter param `/api/v2/coupons?code={value}`
        - name: name
          in: query
          type: string
          description: Optional filter param `/api/v2/coupons?name={value}`
        - name: type
          in: query
          type: string
          description: '|Type|'
        - name: min_id
          in: query
          type: integer
          description: Optional filter param `/api/v2/coupons?min_id={value}`
        - name: max_id
          in: query
          type: integer
          description: Optional filter param`/api/v2/coupons?max_id={value}`
        - name: page
          in: query
          type: number
          description: Number of pages `/api/v2/coupons?page={number}`
        - name: limit
          in: query
          type: number
          description: Count per page `/api/v2/coupons?limit={count}`
        - name: exclude_type
          in: query
          type: string
          description: '|Type|'
      - name: createcoupon
        method: POST
        description: BigCommerce Create a New Coupon
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecoupons
        method: DELETE
        description: BigCommerce Delete All Coupons
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id:in
          in: query
          type: string
          description: Optional param to identify a comma separated list of ids for coupons to delete in a batch. `/api/v2/coupons?id:in=1,2,3`
    - name: coupons-count
      path: /coupons/count
      operations:
      - name: getcouponscount
        method: GET
        description: BigCommerce Get a Count of Coupons
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: coupons-id
      path: /coupons/{id}
      operations:
      - name: updatecoupon
        method: PUT
        description: BigCommerce Update a Coupon
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecoupon
        method: DELETE
        description: BigCommerce Delete a Coupon
        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-coupons-rest
    port: 8080
    description: REST adapter for BigCommerce Marketing — Coupons. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/coupons
      name: coupons
      description: REST surface for coupons.
      operations:
      - method: GET
        name: getcoupons
        description: BigCommerce Get All Coupons
        call: marketing-coupons.getcoupons
        with:
          id: rest.id
          code: rest.code
          name: rest.name
          type: rest.type
          min_id: rest.min_id
          max_id: rest.max_id
          page: rest.page
          limit: rest.limit
          exclude_type: rest.exclude_type
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcoupon
        description: BigCommerce Create a New Coupon
        call: marketing-coupons.createcoupon
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecoupons
        description: BigCommerce Delete All Coupons
        call: marketing-coupons.deletecoupons
        with:
          id:in: rest.id:in
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/coupons/count
      name: coupons-count
      description: REST surface for coupons-count.
      operations:
      - method: GET
        name: getcouponscount
        description: BigCommerce Get a Count of Coupons
        call: marketing-coupons.getcouponscount
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/coupons/{id}
      name: coupons-id
      description: REST surface for coupons-id.
      operations:
      - method: PUT
        name: updatecoupon
        description: BigCommerce Update a Coupon
        call: marketing-coupons.updatecoupon
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecoupon
        description: BigCommerce Delete a Coupon
        call: marketing-coupons.deletecoupon
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: marketing-coupons-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Marketing — Coupons. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: bigcommerce-get-all-coupons
      description: BigCommerce Get All Coupons
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketing-coupons.getcoupons
      with:
        id: tools.id
        code: tools.code
        name: tools.name
        type: tools.type
        min_id: tools.min_id
        max_id: tools.max_id
        page: tools.page
        limit: tools.limit
        exclude_type: tools.exclude_type
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-create-new-coupon
      description: BigCommerce Create a New Coupon
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: marketing-coupons.createcoupon
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-all-coupons
      description: BigCommerce Delete All Coupons
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: marketing-coupons.deletecoupons
      with:
        id:in: tools.id:in
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-get-count-coupons
      description: BigCommerce Get a Count of Coupons
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: marketing-coupons.getcouponscount
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-update-coupon
      description: BigCommerce Update a Coupon
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: marketing-coupons.updatecoupon
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-coupon
      description: BigCommerce Delete a Coupon
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: marketing-coupons.deletecoupon
      outputParameters:
      - type: object
        mapping: $.