applyCheckoutCoupon

Example Query

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

Variables

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

Example response

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

Applies a checkout coupon.

Arguments

inputObjectRequired

Apply checkout coupon input object

Returns

an optional Object

checkoutObject

The Checkout that is updated as a result of mutation.