applyCheckoutCoupon

Example Query

1 mutation ExampleMutation($input: ApplyCheckoutCouponInput!) {
2   checkout {
3     applyCheckoutCoupon(input: $input) {
4       checkout {
5         id
6         entityId
7         currencyCode
8         displayCurrencyCode
9         billingAddress
10         cart
11         shippingConsignments
12         shippingCostTotal
13         shippingCostTotalInDisplayCurrency
14         shippingCostBeforeDiscount
15       }
16     }
17   }
18 }

Variables

1 {
2   "input": {
3     "checkoutEntityId": "example",
4     "data": {
5       "couponCode": "example"
6     },
7     "version": 0
8   }
9 }

Example response

1 {
2   "data": {
3     "checkout": {
4       "applyCheckoutCoupon": {
5         "checkout": {
6           "id": "example",
7           "entityId": "example",
8           "currencyCode": "example",
9           "displayCurrencyCode": "example",
10           "billingAddress": {
11             "entityId": null,
12             "firstName": null,
13             "lastName": null,
14             "email": null,
15             "company": null,
16             "address1": null,
17             "address2": null,
18             "city": null,
19             "stateOrProvince": null,
20             "stateOrProvinceCode": null
21           },
22           "cart": {
23             "id": null,
24             "entityId": null,
25             "currencyCode": null,
26             "displayCurrencyCode": null,
27             "isTaxIncluded": null,
28             "baseAmount": null,
29             "baseAmountInDisplayCurrency": null,
30             "discountedAmount": null,
31             "discountedAmountInDisplayCurrency": null,
32             "amount": null
33           },
34           "shippingConsignments": [
35             {
36               "entityId": null,
37               "address": null,
38               "availableShippingOptions": null,
39               "selectedShippingOption": null,
40               "coupons": null,
41               "shippingCost": null,
42               "shippingCostInDisplayCurrency": null,
43               "shippingCostBeforeDiscount": null,
44               "shippingCostBeforeDiscountInDisplayCurrency": null,
45               "comparisonShippingCost": null
46             }
47           ],
48           "shippingCostTotal": {
49             "currencyCode": null,
50             "value": null,
51             "formatted": null,
52             "formattedV2": null
53           },
54           "shippingCostTotalInDisplayCurrency": {
55             "currencyCode": null,
56             "value": null,
57             "formatted": null,
58             "formattedV2": null
59           },
60           "shippingCostBeforeDiscount": {
61             "currencyCode": null,
62             "value": null,
63             "formatted": null,
64             "formattedV2": null
65           }
66         }
67       }
68     }
69   }
70 }

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.