createCheckout

Example Query

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

Variables

{
  "input": {
    "lineItems": [
      {
        "quantity": 0,
        "productEntityId": 0,
        "variantEntityId": 0,
        "sku": "example",
        "selectedOptions": {
          "checkboxes": [
            {
              "optionEntityId": 0,
              "optionValueEntityId": 0
            }
          ],
          "dateFields": [
            {
              "optionEntityId": 0,
              "date": "2026-10-30T22:30:41.237Z"
            }
          ],
          "multiLineTextFields": [
            {
              "optionEntityId": 0,
              "text": "example"
            }
          ],
          "multipleChoices": [
            {
              "optionEntityId": 0,
              "optionValueEntityId": 0
            }
          ],
          "numberFields": [
            {
              "optionEntityId": 0,
              "number": 0
            }
          ],
          "textFields": [
            {
              "optionEntityId": 0,
              "text": "example"
            }
          ]
        }
      }
    ],
    "giftCertificates": [
      {
        "name": "example",
        "theme": "BIRTHDAY",
        "amount": "example",
        "quantity": 0,
        "sender": {
          "name": "example",
          "email": "example"
        },
        "recipient": {
          "name": "example",
          "email": "example"
        },
        "message": "example"
      }
    ],
    "currencyCode": "example",
    "locale": "example",
    "shippingConsignments": [
      {
        "address": {
          "firstName": "example",
          "lastName": "example",
          "email": "example",
          "company": "example",
          "address1": "example",
          "address2": "example",
          "city": "example",
          "stateOrProvince": "example",
          "stateOrProvinceCode": "example",
          "countryCode": "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"
    },
    "coupons": [
      "example"
    ],
    "externalSource": "example"
  }
}

Example response

{
  "data": {
    "checkout": {
      "createCheckout": {
        "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"
          }
        ]
      }
    }
  }
}

Creates a checkout and generates a checkout ID.

Arguments

inputCreateCheckoutInputRequired

Create checkout input object

Returns

an optional CreateCheckoutResult

errorslist of CreateCheckoutErrors

List of errors that occurred while creating the checkout.

checkoutCheckoutOptional

The Checkout that is created as a result of mutation.