MageSmith
magento/module-quote-graph-ql · Magento 2.4.9

QuoteGraphQl

vendor/magento/module-quote-graph-ql/etc/schema.graphqls

2 queries 20 mutations 80 types

Queries

Mutations

Mutation

addProductsToCart

Add any type of product to the cart.

Quote · returns AddProductsToCartOutput

Mutation

addSimpleProductsToCart

Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead.

Quote · returns AddSimpleProductsToCartOutput

Mutation

addVirtualProductsToCart

Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead.

Quote · returns AddVirtualProductsToCartOutput

Mutation

applyCouponToCart

Apply a pre-defined coupon code to the specified cart.

Quote · returns ApplyCouponToCartOutput

Mutation

assignCustomerToGuestCart

phpcs:ignore Magento2.GraphQL.ValidArgumentName

Quote · returns Cart!

Mutation

createEmptyCart

Deprecated

Create an empty shopping cart for a guest or logged in user

Quote · returns String

Mutation

createGuestCart

Create a new shopping cart

Quote · returns CreateGuestCartOutput

Mutation

estimateShippingMethods

Estimate shipping method(s) for cart based on address

Quote · returns [AvailableShippingMethod]

Mutation

estimateTotals

Estimate totals for cart based on the address

Quote · returns EstimateTotalsOutput!

Mutation

mergeCarts

phpcs:ignore Magento2.GraphQL.ValidArgumentName

Quote · returns Cart!

Mutation

placeOrder

Convert the quote into an order.

Quote · returns PlaceOrderOutput

Mutation

removeCouponFromCart

Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.

Quote · returns RemoveCouponFromCartOutput

Mutation

removeItemFromCart

Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.

Quote · returns RemoveItemFromCartOutput

Mutation

setBillingAddressOnCart

Set the billing address on a specific cart.

Quote · returns SetBillingAddressOnCartOutput

Mutation

setGuestEmailOnCart

Assign the email address of a guest to the cart.

Quote · returns SetGuestEmailOnCartOutput

Mutation

setPaymentMethodAndPlaceOrder

Deprecated

Set the cart payment method and convert the cart into an order.

Quote · returns PlaceOrderOutput

Mutation

setPaymentMethodOnCart

Apply a payment method to the cart.

Quote · returns SetPaymentMethodOnCartOutput

Mutation

setShippingAddressesOnCart

Set one or more shipping addresses on a specific cart.

Quote · returns SetShippingAddressesOnCartOutput

Mutation

setShippingMethodsOnCart

Set one or more delivery methods on a cart.

Quote · returns SetShippingMethodsOnCartOutput

Mutation

updateCartItems

Modify items in the cart.

Quote · returns UpdateCartItemsOutput

Types

Object types, input types, enums, interfaces, and unions declared (or extended) in this module.

OBJECT

AddProductsToCartOutput

Contains details about the cart after adding products to it.

INPUT_OBJECT

AddSimpleProductsToCartInput

Defines the simple and group products to add to the cart.

OBJECT

AddSimpleProductsToCartOutput

Contains details about the cart after adding simple or group products.

INPUT_OBJECT

AddVirtualProductsToCartInput

Defines the virtual products to add to the cart.

OBJECT

AddVirtualProductsToCartOutput

Contains details about the cart after adding virtual products.

OBJECT

AppliedCoupon

Contains the applied coupon code.

INPUT_OBJECT

ApplyCouponToCartInput

Specifies the coupon code to apply to the cart.

OBJECT

ApplyCouponToCartOutput

Contains details about the cart after applying a coupon.

OBJECT

AvailablePaymentMethod

Describes a payment method that the shopper can use to pay for the order.

OBJECT

AvailableShippingMethod

Contains details about the possible shipping methods and carriers.

INPUT_OBJECT

BillingAddressInput

Defines the billing address.

OBJECT

BillingCartAddress

Contains details about the billing address.

OBJECT

Cart

Contains the contents and other details about a guest or customer cart.

OBJECT

CartAddressCountry

Contains details the country in a billing or shipping address.

INPUT_OBJECT

CartAddressInput

Defines the billing or shipping address to be applied to the cart.

INTERFACE

CartAddressInterface

OBJECT

CartAddressRegion

Contains details about the region in a billing or shipping address.

OBJECT

CartDiscount

Contains information about discounts applied to the cart.

ENUM

CartDiscountType

OBJECT

CartItemError

ENUM

CartItemErrorType

INPUT_OBJECT

CartItemInput

Defines an item to be added to the cart.

INTERFACE

CartItemInterface

An interface for products in a cart.

OBJECT

CartItemPrices

Contains details about the price of the item, including taxes and discounts.

OBJECT

CartItemQuantity

Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.

OBJECT

CartItemSelectedOptionValuePrice

Contains details about the price of a selected customizable value.

INPUT_OBJECT

CartItemUpdateInput

A single item to be updated.

OBJECT

CartItems

OBJECT

CartPrices

Contains details about the final price of items in the cart, including discount and tax information.

OBJECT

CartTaxItem

Contains tax information about an item in the cart.

OBJECT

CartUserInputError

ENUM

CartUserInputErrorType

INPUT_OBJECT

CreateGuestCartInput

OBJECT

CreateGuestCartOutput

INPUT_OBJECT

CustomizableOptionInput

Defines a customizable option.

OBJECT

Discount

Defines an individual discount. A discount can be applied to the cart as a whole or to an item, shipping.

INTERFACE

Error

An error encountered while adding an item to the the cart.

INPUT_OBJECT

EstimateAddressInput

Contains details about an address.

INPUT_OBJECT

EstimateTotalsInput

OBJECT

EstimateTotalsOutput

Estimate totals output.

OBJECT

InsufficientStockError

OBJECT

Order

Contains the order ID.

INPUT_OBJECT

PaymentMethodInput

Defines the payment method.

OBJECT

PlaceOrderError

An error encountered while placing an order.

ENUM

PlaceOrderErrorCodes

INPUT_OBJECT

PlaceOrderInput

Specifies the quote to be converted to an order.

OBJECT

PlaceOrderOutput

Contains the results of the request to place an order.

ENUM

ProductImageThumbnail

INPUT_OBJECT

QuoteItemsSortInput

Specifies the field to use for sorting quote items

INPUT_OBJECT

RemoveCouponFromCartInput

Specifies the cart from which to remove a coupon.

OBJECT

RemoveCouponFromCartOutput

Contains details about the cart after removing a coupon.

INPUT_OBJECT

RemoveItemFromCartInput

Specifies which items to remove from the cart.

OBJECT

RemoveItemFromCartOutput

Contains details about the cart after removing an item.

OBJECT

SelectedCustomizableOption

Identifies a customized product that has been placed in a cart.

OBJECT

SelectedCustomizableOptionValue

Identifies the value of the selected customized option.

OBJECT

SelectedPaymentMethod

Describes the payment method the shopper selected.

OBJECT

SelectedShippingMethod

Contains details about the selected shipping method and carrier.

INPUT_OBJECT

SetBillingAddressOnCartInput

Sets the billing address.

OBJECT

SetBillingAddressOnCartOutput

Contains details about the cart after setting the billing address.

INPUT_OBJECT

SetGuestEmailOnCartInput

Defines the guest email and cart.

OBJECT

SetGuestEmailOnCartOutput

Contains details about the cart after setting the email of a guest.

INPUT_OBJECT

SetPaymentMethodAndPlaceOrderInput

Applies a payment method to the quote.

INPUT_OBJECT

SetPaymentMethodOnCartInput

Applies a payment method to the cart.

OBJECT

SetPaymentMethodOnCartOutput

Contains details about the cart after setting the payment method.

INPUT_OBJECT

SetShippingAddressesOnCartInput

Specifies an array of addresses to use for shipping.

OBJECT

SetShippingAddressesOnCartOutput

Contains details about the cart after setting the shipping addresses.

INPUT_OBJECT

SetShippingMethodsOnCartInput

Applies one or shipping methods to the cart.

OBJECT

SetShippingMethodsOnCartOutput

Contains details about the cart after setting the shipping methods.

INPUT_OBJECT

ShippingAddressInput

Defines a single shipping address.

OBJECT

ShippingCartAddress

Contains shipping addresses and methods.

INPUT_OBJECT

ShippingMethodInput

Defines the shipping carrier and method.

OBJECT

SimpleCartItem

An implementation for simple product cart items.

INPUT_OBJECT

SimpleProductCartItemInput

Defines a single product to add to the cart.

ENUM

SortQuoteItemsEnum

Specifies the field to use for sorting quote items

OBJECT

StoreConfig

Contains information about a store's configuration.

INPUT_OBJECT

UpdateCartItemsInput

Modifies the specified items in the cart.

OBJECT

UpdateCartItemsOutput

Contains details about the cart after updating items.

OBJECT

VirtualCartItem

An implementation for virtual product cart items.

INPUT_OBJECT

VirtualProductCartItemInput

Defines a single product to add to the cart.

INPUT_OBJECT

createEmptyCartInput

Assigns a specific `cart_id` to the empty cart.

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.