Choose a version:

cartCreate

mutation

Creates a new Cart for a buyer session. You can optionally initialize the cart with merchandise lines, discount codes, gift card codes, buyer identity for international pricing, and custom attributes.

The returned cart includes a checkoutUrl that directs the buyer to complete their purchase.

Anchor to Arguments

Arguments

Anchor to inputinput

•CartInput

The fields used to create a cart.

Was this section helpful?

Anchor to CartCreatePayload returnsCartCreatePayload returns

Anchor to cartcart •Cart: The new cart.
Anchor to userErrorsuserErrors •[CartUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to warningswarnings •[CartWarning!]! non-null: A list of warnings that occurred during the mutation.

Was this section helpful?

Examples

cartCreate reference

Mutation Reference

mutation cartCreate($input: CartInput) {

cartCreate(input: $input) {

cart {

# Cart fields

}

userErrors {

field

message

}

warnings {

# CartWarning fields

}

Input

{

"input": {

"attributes": [

{

"key": "<your-key>",

"value": "<your-value>"

}

"buyerIdentity": {

"companyLocationId": "gid://shopify/<objectName>/10079785100",

"countryCode": "AC",

"customerAccessToken": "<your-customerAccessToken>",

"email": "<your-email>",

"phone": "<your-phone>",

"preferences": {}

"delivery": {

"addresses": [

{}

]

"discountCodes": [

"<your-discountCodes>"

"giftCardCodes": [

"<your-giftCardCodes>"

"lines": [

{

"attributes": [

{}

"merchandiseId": "gid://shopify/<objectName>/10079785100",

"parent": {},

"quantity": 1,

"sellingPlanId": "gid://shopify/<objectName>/10079785100"

}

"metafields": [

{

"key": "<your-key>",

"type": "<your-type>",

"value": "<your-value>"

}

"note": "<your-note>",

"sourceName": "<your-sourceName>"

}

Variables

{
  "input": {
    "attributes": [
      {
        "key": "<your-key>",
        "value": "<your-value>"
      }
    ],
    "buyerIdentity": {
      "companyLocationId": "gid://shopify/<objectName>/10079785100",
      "countryCode": "AC",
      "customerAccessToken": "<your-customerAccessToken>",
      "email": "<your-email>",
      "phone": "<your-phone>",
      "preferences": {}
    },
    "delivery": {
      "addresses": [
        {}
      ]
    },
    "discountCodes": [
      "<your-discountCodes>"
    ],
    "giftCardCodes": [
      "<your-giftCardCodes>"
    ],
    "lines": [
      {
        "attributes": [
          {}
        ],
        "merchandiseId": "gid://shopify/<objectName>/10079785100",
        "parent": {},
        "quantity": 1,
        "sellingPlanId": "gid://shopify/<objectName>/10079785100"
      }
    ],
    "metafields": [
      {
        "key": "<your-key>",
        "type": "<your-type>",
        "value": "<your-value>"
      }
    ],
    "note": "<your-note>",
    "sourceName": "<your-sourceName>"
  }
}

Schema

input CartInput {
  attributes: [AttributeInput!]
  buyerIdentity: CartBuyerIdentityInput
  delivery: CartDeliveryInput
  discountCodes: [String!]
  giftCardCodes: [String!]
  lines: [CartLineInput!]
  metafields: [CartInputMetafieldInput!]
  note: String
  sourceName: String
}

input AttributeInput {
  key: String!
  value: String!
}

input CartBuyerIdentityInput {
  companyLocationId: ID
  countryCode: CountryCode
  customerAccessToken: String
  email: String
  phone: String
  preferences: CartPreferencesInput
}

input CartDeliveryInput {
  addresses: [CartSelectableAddressInput!]
}

input CartLineInput {
  attributes: [AttributeInput!]
  merchandiseId: ID!
  parent: CartLineParentInput
  quantity: Int
  sellingPlanId: ID
}

input CartInputMetafieldInput {
  key: String!
  type: String!
  value: String!
}