updateCheckout

Example Query

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

Variables

{
  "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,
          "shippingOptionSelectionStrategy": "LEAST_EXPENSIVE"
        }
      ],
      "billingAddress": {
        "firstName": "example",
        "lastName": "example",
        "email": "example",
        "company": "example",
        "address1": "example",
        "address2": "example",
        "city": "example",
        "stateOrProvince": "example",
        "stateOrProvinceCode": "example",
        "countryCode": "example"
      },
      "customerMessage": "example",
      "coupons": [
        "example"
      ]
    },
    "version": 0
  }
}

Example response

{
  "data": {
    "checkout": {
      "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
          }
        },
        "errors": [
          {
            "code": "ATTRIBUTES_NOT_APPLICABLE",
            "context": [
              {
                "field": null,
                "value": null
              }
            ],
            "message": "example"
          }
        ]
      }
    }
  }
}

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.

checkoutCheckoutOptional

The Checkout that is updated as a result of mutation.