updateCheckout

Example Query

1 mutation ExampleMutation($input: UpdateCheckoutInput!) {
2   checkout {
3     updateCheckout(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       errors
17     }
18   }
19 }

Variables

1 {
2   "input": {
3     "checkoutEntityId": "example",
4     "data": {
5       "lineItems": [
6         {
7           "entityId": "example",
8           "quantity": 0,
9           "productEntityId": 0,
10           "variantEntityId": 0,
11           "sku": "example",
12           "selectedOptions": {
13             "checkboxes": [
14               {
15                 "optionEntityId": null,
16                 "optionValueEntityId": null
17               }
18             ],
19             "dateFields": [
20               {
21                 "optionEntityId": null,
22                 "date": null
23               }
24             ],
25             "multiLineTextFields": [
26               {
27                 "optionEntityId": null,
28                 "text": null
29               }
30             ],
31             "multipleChoices": [
32               {
33                 "optionEntityId": null,
34                 "optionValueEntityId": null
35               }
36             ],
37             "numberFields": [
38               {
39                 "optionEntityId": null,
40                 "number": null
41               }
42             ],
43             "textFields": [
44               {
45                 "optionEntityId": null,
46                 "text": null
47               }
48             ]
49           }
50         }
51       ],
52       "shippingConsignments": [
53         {
54           "entityId": "example",
55           "address": {
56             "firstName": "example",
57             "lastName": "example",
58             "email": "example",
59             "company": "example",
60             "address1": "example",
61             "address2": "example",
62             "city": "example",
63             "stateOrProvince": "example",
64             "stateOrProvinceCode": "example",
65             "countryCode": "example"
66           },
67           "lineItems": [
68             {
69               "lineItemEntityId": "example",
70               "quantity": 0
71             }
72           ],
73           "shippingOptionEntityId": "example",
74           "selectRecommendedOption": true
75         }
76       ],
77       "billingAddress": {
78         "firstName": "example",
79         "lastName": "example",
80         "email": "example",
81         "company": "example",
82         "address1": "example",
83         "address2": "example",
84         "city": "example",
85         "stateOrProvince": "example",
86         "stateOrProvinceCode": "example",
87         "countryCode": "example"
88       },
89       "customerMessage": "example",
90       "coupons": [
91         "example"
92       ]
93     },
94     "version": 0
95   }
96 }

Example response

1 {
2   "data": {
3     "checkout": {
4       "updateCheckout": {
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         "errors": [
68           {
69             "code": "ATTRIBUTES_NOT_APPLICABLE",
70             "message": "example"
71           }
72         ]
73       }
74     }
75   }
76 }

Update a checkout.

Arguments

inputUpdateCheckoutInputRequired

Update checkout input object

Returns

an optional UpdateCheckoutResult

errorslist of UpdateCheckoutErrors

List of errors that occurred while updating the checkout.

checkoutCheckout

The Checkout that is updated as a result of mutation.