BigCommerce Storefront Checkouts — Checkout Coupons

naftiko: 1.0.0-alpha2
info:
  label: BigCommerce Storefront Checkouts — Checkout Coupons
  description: 'BigCommerce Storefront Checkouts — Checkout Coupons. 2 operations. Lead operation: BigCommerce Add Coupon
    to Checkout. Self-contained Naftiko capability covering one Bigcommerce business surface.'
  tags:
  - Bigcommerce
  - Checkout Coupons
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BIGCOMMERCE_API_KEY: BIGCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: storefront-checkouts-checkout-coupons
    baseUri: https://{store_domain}/api/storefront
    description: BigCommerce Storefront Checkouts — Checkout Coupons business capability. Self-contained, no shared references.
    resources:
    - name: checkouts-checkoutId-coupons
      path: /checkouts/{checkoutId}/coupons
      operations:
      - name: addcheckoutcoupon
        method: POST
        description: BigCommerce Add Coupon to Checkout
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: checkoutId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: checkouts-checkoutId-coupons-couponCode
      path: /checkouts/{checkoutId}/coupons/{couponCode}
      operations:
      - name: deletecheckoutcoupon
        method: DELETE
        description: BigCommerce Delete Checkout Coupon
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: checkoutId
          in: path
          type: string
          required: true
        - name: couponCode
          in: path
          type: string
          required: true
  exposes:
  - type: rest
    namespace: storefront-checkouts-checkout-coupons-rest
    port: 8080
    description: REST adapter for BigCommerce Storefront Checkouts — Checkout Coupons. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/checkouts/{checkoutid}/coupons
      name: checkouts-checkoutid-coupons
      description: REST surface for checkouts-checkoutId-coupons.
      operations:
      - method: POST
        name: addcheckoutcoupon
        description: BigCommerce Add Coupon to Checkout
        call: storefront-checkouts-checkout-coupons.addcheckoutcoupon
        with:
          checkoutId: rest.checkoutId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/checkouts/{checkoutid}/coupons/{couponcode}
      name: checkouts-checkoutid-coupons-couponcode
      description: REST surface for checkouts-checkoutId-coupons-couponCode.
      operations:
      - method: DELETE
        name: deletecheckoutcoupon
        description: BigCommerce Delete Checkout Coupon
        call: storefront-checkouts-checkout-coupons.deletecheckoutcoupon
        with:
          checkoutId: rest.checkoutId
          couponCode: rest.couponCode
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: storefront-checkouts-checkout-coupons-mcp
    port: 9090
    transport: http
    description: MCP adapter for BigCommerce Storefront Checkouts — Checkout Coupons. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: bigcommerce-add-coupon-checkout
      description: BigCommerce Add Coupon to Checkout
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: storefront-checkouts-checkout-coupons.addcheckoutcoupon
      with:
        checkoutId: tools.checkoutId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: bigcommerce-delete-checkout-coupon
      description: BigCommerce Delete Checkout Coupon
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: storefront-checkouts-checkout-coupons.deletecheckoutcoupon
      with:
        checkoutId: tools.checkoutId
        couponCode: tools.couponCode
      outputParameters:
      - type: object
        mapping: $.