What arguments does createCompareList accept?

The createCompareList mutation accepts 1 argument: input (CreateCompareListInput).

What does createCompareList return?

createCompareList returns CompareList.

Does createCompareList require authentication?

createCompareList requires an Authorization header with a Bearer customer token. Obtain the token by calling the generateCustomerToken mutation with the customer's email and password.

MageSmith

MutationCompareList · Magento 2.4.9

createCompareList

Q: What does the createCompareList mutation do in Magento 2 GraphQL?

createCompareList is a Magento 2 GraphQL mutation in the CompareList module. Create a new compare list. The compare list is saved for logged in customers. It returns CompareList and requires an Authorization header (Bearer customer token).

createCompareList is a Magento 2 GraphQL mutation in the CompareList module. Create a new compare list. The compare list is saved for logged in customers. It returns CompareList and requires an Authorization header (Bearer customer token).

Last verified: 2026-05-23 against Magento 2.4.9.

Returns

CompareList

Resolver class

\Magento\CompareListGraphQl\Model\Resolver\CreateCompareList

Arguments

input CreateCompareListInput

Example request

Auto-generated from the SDL — paste-ready against your store's /graphql endpoint. Replace the host, store code, and any required values before running.

Headers

Content-Type

application/json

Store

default store view code; use 'default' for the single-store baseline

Authorization

Bearer <CUSTOMER_TOKEN> obtain from generateCustomerToken mutation

Query

mutation {
  createCompareList {
    uid
    items {
      uid
      product {
        id
        uid
        name
        sku
        description { ... }
        short_description { ... }
        special_price
        special_from_date
        special_to_date
        attribute_set_id
        meta_title
        meta_keyword
        meta_description
        image { ... }
        small_image { ... }
        thumbnail { ... }
        new_from_date
        new_to_date
        tier_price
        options_container
        created_at
        updated_at
        country_of_manufacture
        type_id
        websites { ... }
        product_links { ... }
        media_gallery_entries { ... }
        price { ... }
        price_range { ... }
        gift_message_available
        manufacturer
        categories { ... }
        canonical_url
        media_gallery { ... }
        custom_attributesV2 { ... }
        tier_prices { ... }
        price_tiers { ... }
        only_x_left_in_stock
        stock_status
        quantity
        min_sale_qty
        max_sale_qty
        url_key
        url_suffix
        url_path
        url_rewrites { ... }
        related_products { ... }
        upsell_products { ... }
        crosssell_products { ... }
        rating_summary
        review_count
        reviews { ... }
        swatch_image
      }
      attributes {
        code
        value
      }
    }
    attributes {
      code
      label
    }
    item_count
  }
}