updateCheckout | BigCommerce Developer Center

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

{
  "input": {
    "checkoutEntityId": "example",
    "data": {
      "lineItems": [
        {
          "entityId": "example",
          "quantity": 0,
          "productEntityId": 0,
          "variantEntityId": 0,
          "sku": "example",
          "selectedOptions": {
            "checkboxes": [
              {
                "optionEntityId": null,
                "optionValueEntityId": null
              }
            ],
            "dateFields": [
              {
                "optionEntityId": null,
                "date": null
              }
            ],
            "multiLineTextFields": [
              {
                "optionEntityId": null,
                "text": null
              }
            ],
            "multipleChoices": [
              {
                "optionEntityId": null,
                "optionValueEntityId": null
              }
            ],
            "numberFields": [
              {
                "optionEntityId": null,
                "number": null
              }
            ],
            "textFields": [
              {
                "optionEntityId": null,
                "text": null
              }
            ]
          }
        }
      ],
      "shippingConsignments": [
        {
          "entityId": "example",
          "address": {
            "firstName": "example",
            "lastName": "example",
            "email": "example",
            "company": "example",
            "address1": "example",
            "address2": "example",
            "city": "example",
            "stateOrProvince": "example",
            "stateOrProvinceCode": "example",
            "countryCode": "example"
          },
          "lineItems": [
            {
              "lineItemEntityId": "example",
              "quantity": 0
            }
          ],
          "shippingOptionEntityId": "example",
          "selectRecommendedOption": true
        }
      ],
      "billingAddress": {
        "firstName": "example",
        "lastName": "example",
        "email": "example",
        "company": "example",
        "address1": "example",
        "address2": "example",
        "city": "example",
        "stateOrProvince": "example",
        "stateOrProvinceCode": "example",
        "countryCode": "example"
      },
      "customerMessage": "example"
    },
    "version": 0
  }
}

{
  "data": {
    "updateCheckout": {
      "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
        }
      }
    }
  }
}

Update a checkout.

Arguments

inputObjectRequired

Update checkout input object

Returns

an optional Object

checkoutObject

The Checkout that is updated as a result of mutation.

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	},
91	"version": 0
92	}
93	}