QuoteGraphQl
vendor/magento/module-quote-graph-ql/etc/schema.graphqls
Queries
Mutations
addProductsToCart
Add any type of product to the cart.
Quote · returns AddProductsToCartOutput
addSimpleProductsToCart
Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead.
Quote · returns AddSimpleProductsToCartOutput
addVirtualProductsToCart
Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead.
Quote · returns AddVirtualProductsToCartOutput
applyCouponToCart
Apply a pre-defined coupon code to the specified cart.
Quote · returns ApplyCouponToCartOutput
assignCustomerToGuestCart
phpcs:ignore Magento2.GraphQL.ValidArgumentName
Quote · returns Cart!
createEmptyCart
DeprecatedCreate an empty shopping cart for a guest or logged in user
Quote · returns String
createGuestCart
Create a new shopping cart
Quote · returns CreateGuestCartOutput
estimateShippingMethods
Estimate shipping method(s) for cart based on address
Quote · returns [AvailableShippingMethod]
estimateTotals
Estimate totals for cart based on the address
Quote · returns EstimateTotalsOutput!
mergeCarts
phpcs:ignore Magento2.GraphQL.ValidArgumentName
Quote · returns Cart!
placeOrder
Convert the quote into an order.
Quote · returns PlaceOrderOutput
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
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
setBillingAddressOnCart
Set the billing address on a specific cart.
Quote · returns SetBillingAddressOnCartOutput
setGuestEmailOnCart
Assign the email address of a guest to the cart.
Quote · returns SetGuestEmailOnCartOutput
setPaymentMethodAndPlaceOrder
DeprecatedSet the cart payment method and convert the cart into an order.
Quote · returns PlaceOrderOutput
setPaymentMethodOnCart
Apply a payment method to the cart.
Quote · returns SetPaymentMethodOnCartOutput
setShippingAddressesOnCart
Set one or more shipping addresses on a specific cart.
Quote · returns SetShippingAddressesOnCartOutput
setShippingMethodsOnCart
Set one or more delivery methods on a cart.
Quote · returns SetShippingMethodsOnCartOutput
updateCartItems
Modify items in the cart.
Quote · returns UpdateCartItemsOutput
Types
Object types, input types, enums, interfaces, and unions declared (or extended) in this module.
AddProductsToCartOutput
Contains details about the cart after adding products to it.
AddSimpleProductsToCartInput
Defines the simple and group products to add to the cart.
AddSimpleProductsToCartOutput
Contains details about the cart after adding simple or group products.
AddVirtualProductsToCartInput
Defines the virtual products to add to the cart.
AddVirtualProductsToCartOutput
Contains details about the cart after adding virtual products.
AppliedCoupon
Contains the applied coupon code.
ApplyCouponToCartInput
Specifies the coupon code to apply to the cart.
ApplyCouponToCartOutput
Contains details about the cart after applying a coupon.
AvailablePaymentMethod
Describes a payment method that the shopper can use to pay for the order.
AvailableShippingMethod
Contains details about the possible shipping methods and carriers.
BillingAddressInput
Defines the billing address.
BillingCartAddress
Contains details about the billing address.
Cart
Contains the contents and other details about a guest or customer cart.
CartAddressCountry
Contains details the country in a billing or shipping address.
CartAddressInput
Defines the billing or shipping address to be applied to the cart.
CartAddressInterface
CartAddressRegion
Contains details about the region in a billing or shipping address.
CartDiscount
Contains information about discounts applied to the cart.
CartDiscountType
CartItemError
CartItemErrorType
CartItemInput
Defines an item to be added to the cart.
CartItemInterface
An interface for products in a cart.
CartItemPrices
Contains details about the price of the item, including taxes and discounts.
CartItemQuantity
Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.
CartItemSelectedOptionValuePrice
Contains details about the price of a selected customizable value.
CartItemUpdateInput
A single item to be updated.
CartItems
CartPrices
Contains details about the final price of items in the cart, including discount and tax information.
CartTaxItem
Contains tax information about an item in the cart.
CartUserInputError
CartUserInputErrorType
CreateGuestCartInput
CreateGuestCartOutput
CustomizableOptionInput
Defines a customizable option.
Discount
Defines an individual discount. A discount can be applied to the cart as a whole or to an item, shipping.
Error
An error encountered while adding an item to the the cart.
EstimateAddressInput
Contains details about an address.
EstimateTotalsInput
EstimateTotalsOutput
Estimate totals output.
InsufficientStockError
Order
Contains the order ID.
PaymentMethodInput
Defines the payment method.
PlaceOrderError
An error encountered while placing an order.
PlaceOrderErrorCodes
PlaceOrderInput
Specifies the quote to be converted to an order.
PlaceOrderOutput
Contains the results of the request to place an order.
ProductImageThumbnail
QuoteItemsSortInput
Specifies the field to use for sorting quote items
RemoveCouponFromCartInput
Specifies the cart from which to remove a coupon.
RemoveCouponFromCartOutput
Contains details about the cart after removing a coupon.
RemoveItemFromCartInput
Specifies which items to remove from the cart.
RemoveItemFromCartOutput
Contains details about the cart after removing an item.
SelectedCustomizableOption
Identifies a customized product that has been placed in a cart.
SelectedCustomizableOptionValue
Identifies the value of the selected customized option.
SelectedPaymentMethod
Describes the payment method the shopper selected.
SelectedShippingMethod
Contains details about the selected shipping method and carrier.
SetBillingAddressOnCartInput
Sets the billing address.
SetBillingAddressOnCartOutput
Contains details about the cart after setting the billing address.
SetGuestEmailOnCartInput
Defines the guest email and cart.
SetGuestEmailOnCartOutput
Contains details about the cart after setting the email of a guest.
SetPaymentMethodAndPlaceOrderInput
Applies a payment method to the quote.
SetPaymentMethodOnCartInput
Applies a payment method to the cart.
SetPaymentMethodOnCartOutput
Contains details about the cart after setting the payment method.
SetShippingAddressesOnCartInput
Specifies an array of addresses to use for shipping.
SetShippingAddressesOnCartOutput
Contains details about the cart after setting the shipping addresses.
SetShippingMethodsOnCartInput
Applies one or shipping methods to the cart.
SetShippingMethodsOnCartOutput
Contains details about the cart after setting the shipping methods.
ShippingAddressInput
Defines a single shipping address.
ShippingCartAddress
Contains shipping addresses and methods.
ShippingMethodInput
Defines the shipping carrier and method.
SimpleCartItem
An implementation for simple product cart items.
SimpleProductCartItemInput
Defines a single product to add to the cart.
SortQuoteItemsEnum
Specifies the field to use for sorting quote items
StoreConfig
Contains information about a store's configuration.
UpdateCartItemsInput
Modifies the specified items in the cart.
UpdateCartItemsOutput
Contains details about the cart after updating items.
VirtualCartItem
An implementation for virtual product cart items.
VirtualProductCartItemInput
Defines a single product to add to the cart.
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.