BigCommerce Docs

mutation ExampleMutation($input: ApplyCheckoutCouponInput) {
  applyCheckoutCoupon(input: $input) {
    checkout {
      id
      entityId
      currencyCode
      displayCurrencyCode
      billingAddress
      cart
      shippingConsignments
      shippingCostTotal
      shippingCostTotalInDisplayCurrency
      shippingCostBeforeDiscount
    }
  }
}

{
  "input": {
    "checkoutEntityId": "example",
    "data": {
      "couponCode": "example"
    },
    "version": 0
  }
}

{
  "data": {
    "applyCheckoutCoupon": {
      "checkout": {
        "id": "example",
        "entityId": "example",
        "currencyCode": "example",
        "displayCurrencyCode": "example",
        "billingAddress": {
          "entityId": null,
          "firstName": null,
          "lastName": null,
          "email": null,
          "company": null,
          "address1": null,
          "address2": null,
          "city": null,
          "stateOrProvince": null,
          "stateOrProvinceCode": null
        },
        "cart": {
          "id": null,
          "entityId": null,
          "currencyCode": null,
          "displayCurrencyCode": null,
          "isTaxIncluded": null,
          "baseAmount": null,
          "baseAmountInDisplayCurrency": null,
          "discountedAmount": null,
          "discountedAmountInDisplayCurrency": null,
          "amount": null
        },
        "shippingConsignments": [
          {
            "entityId": null,
            "address": null,
            "availableShippingOptions": null,
            "selectedShippingOption": null,
            "coupons": null,
            "shippingCost": null,
            "shippingCostInDisplayCurrency": null,
            "shippingCostBeforeDiscount": null,
            "shippingCostBeforeDiscountInDisplayCurrency": null,
            "comparisonShippingCost": null
          }
        ],
        "shippingCostTotal": {
          "currencyCode": null,
          "value": null,
          "formatted": null,
          "formattedV2": null
        },
        "shippingCostTotalInDisplayCurrency": {
          "currencyCode": null,
          "value": null,
          "formatted": null,
          "formattedV2": null
        },
        "shippingCostBeforeDiscount": {
          "currencyCode": null,
          "value": null,
          "formatted": null,
          "formattedV2": null
        }
      }
    }
  }
}

Applies a checkout coupon.

Arguments

inputApplyCheckoutCouponInputRequired

Apply checkout coupon input object

Returns

an optional ApplyCheckoutCouponResult

checkoutCheckout

The Checkout that is updated as a result of mutation.