createCheckout

Example Query

1 mutation ExampleMutation($input: CreateCheckoutInput!) {
2   checkout {
3     createCheckout(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     "lineItems": [
4       {
5         "quantity": 0,
6         "productEntityId": 0,
7         "variantEntityId": 0,
8         "sku": "example",
9         "selectedOptions": {
10           "checkboxes": [
11             {
12               "optionEntityId": 0,
13               "optionValueEntityId": 0
14             }
15           ],
16           "dateFields": [
17             {
18               "optionEntityId": 0,
19               "date": "2026-06-15T17:18:45.645Z"
20             }
21           ],
22           "multiLineTextFields": [
23             {
24               "optionEntityId": 0,
25               "text": "example"
26             }
27           ],
28           "multipleChoices": [
29             {
30               "optionEntityId": 0,
31               "optionValueEntityId": 0
32             }
33           ],
34           "numberFields": [
35             {
36               "optionEntityId": 0,
37               "number": 0
38             }
39           ],
40           "textFields": [
41             {
42               "optionEntityId": 0,
43               "text": "example"
44             }
45           ]
46         }
47       }
48     ],
49     "giftCertificates": [
50       {
51         "name": "example",
52         "theme": "BIRTHDAY",
53         "amount": "example",
54         "quantity": 0,
55         "sender": {
56           "name": "example",
57           "email": "example"
58         },
59         "recipient": {
60           "name": "example",
61           "email": "example"
62         },
63         "message": "example"
64       }
65     ],
66     "currencyCode": "example",
67     "locale": "example",
68     "shippingConsignments": [
69       {
70         "address": {
71           "firstName": "example",
72           "lastName": "example",
73           "email": "example",
74           "company": "example",
75           "address1": "example",
76           "address2": "example",
77           "city": "example",
78           "stateOrProvince": "example",
79           "stateOrProvinceCode": "example",
80           "countryCode": "example"
81         },
82         "selectRecommendedOption": true
83       }
84     ],
85     "billingAddress": {
86       "firstName": "example",
87       "lastName": "example",
88       "email": "example",
89       "company": "example",
90       "address1": "example",
91       "address2": "example",
92       "city": "example",
93       "stateOrProvince": "example",
94       "stateOrProvinceCode": "example",
95       "countryCode": "example"
96     },
97     "coupons": [
98       "example"
99     ]
100   }
101 }

Example response

1 {
2   "data": {
3     "checkout": {
4       "createCheckout": {
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 }

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.

checkoutCheckout

The Checkout that is created as a result of mutation.