createCheckout | BigCommerce Developer Center

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

{
  "input": {
    "lineItems": [
      {
        "quantity": 0,
        "productEntityId": 0,
        "variantEntityId": 0,
        "sku": "example",
        "selectedOptions": {
          "checkboxes": [
            {
              "optionEntityId": 0,
              "optionValueEntityId": 0
            }
          ],
          "dateFields": [
            {
              "optionEntityId": 0,
              "date": "DateTime"
            }
          ],
          "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": "BigDecimal",
        "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
      }
    ],
    "billingAddress": {
      "firstName": "example",
      "lastName": "example",
      "email": "example",
      "company": "example",
      "address1": "example",
      "address2": "example",
      "city": "example",
      "stateOrProvince": "example",
      "stateOrProvinceCode": "example",
      "countryCode": "example"
    }
  }
}

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

Creates a checkout and generates a checkout ID.

Arguments

inputObjectRequired

Create checkout input object

Returns

an optional Object

checkoutObject

The Checkout that is created as a result of mutation.

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": "DateTime"
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": "BigDecimal",
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	}
98	}