Docs
Back

API Reference

magento-types

  • Enums
    • CartUserInputErrorType
    • CheckoutAgreementMode
    • CheckoutUserInputErrorCodes
    • CountryCodeEnum
    • CurrencyEnum
    • CustomizableDateTypeEnum
    • DownloadableFileTypeEnum
    • FixedProductTaxDisplaySettings
    • MagentoCustomerGender
    • PayflowLinkMode
    • PaymentTokenTypeEnum
    • PriceAdjustmentCodesEnum
    • PriceAdjustmentDescriptionEnum
    • PriceTypeEnum
    • PriceViewEnum
    • ProductsQueryType
    • ProductStockStatus
    • ShipBundleItemsEnum
    • SortEnum
    • SubscriptionStatusesEnum
    • UrlRewriteEntityTypeEnum
    • UseInLayeredNavigationOptions
    • WishlistCartUserInputErrorType
    • WishListUserInputErrorType
  • Interfaces
    • AddBundleProductsToCartInput
    • AddBundleProductsToCartOutput
    • AddConfigurableProductsToCartInput
    • AddConfigurableProductsToCartOutput
    • AddDownloadableProductsToCartInput
    • AddDownloadableProductsToCartOutput
    • AddProductsToCartOutput
    • AddProductsToCompareListInput
    • AddProductsToWishlistOutput
    • AddSimpleProductsToCartInput
    • AddSimpleProductsToCartOutput
    • AddVirtualProductsToCartInput
    • AddVirtualProductsToCartOutput
    • AddWishlistItemsToCartOutput
    • Aggregation
    • AggregationOption
    • AggregationOptionInterface
    • AppliedCoupon
    • ApplyCouponToCartInput
    • ApplyCouponToCartOutput
    • AreaInput
    • Assets
    • AssignCompareListToCustomerOutput
    • Attribute
    • AttributeInput
    • AttributeOption
    • AvailablePaymentMethod
    • AvailableShippingMethod
    • BillingAddressInput
    • BillingCartAddress
    • BraintreeCcVaultInput
    • BraintreeInput
    • Breadcrumb
    • BundleCartItem
    • BundleCreditMemoItem
    • BundleInvoiceItem
    • BundleItem
    • BundleItemOption
    • BundleOptionInput
    • BundleOrderItem
    • BundleProduct
    • BundleProductCartItemInput
    • BundleProductReviewsArgs
    • BundleShipmentItem
    • BundleWishlistItem
    • Cart
    • CartAddressCountry
    • CartAddressInput
    • CartAddressInterface
    • CartAddressRegion
    • CartDiscount
    • CartItemInput
    • CartItemInterface
    • CartItemPrices
    • CartItemQuantity
    • CartItemSelectedOptionValuePrice
    • CartItemUpdateInput
    • CartPrices
    • CartTaxItem
    • CartUserInputError
    • Categories
    • CategoryFilterInput
    • CategoryInterface
    • CategoryInterfaceProductsArgs
    • CategoryProducts
    • CategoryResult
    • CategoryTree
    • CategoryTreeProductsArgs
    • ChatData
    • CheckoutAgreement
    • CheckoutUserInputError
    • CmsBlock
    • CmsBlocks
    • CmsPage
    • ColorSwatchData
    • ComparableAttribute
    • ComparableItem
    • CompareList
    • ComplexTextValue
    • ConfigurableAttributeOption
    • ConfigurableCartItem
    • ConfigurableOptionAvailableForSelection
    • ConfigurableProduct
    • ConfigurableProductCartItemInput
    • ConfigurableProductConfigurable_Product_Options_SelectionArgs
    • ConfigurableProductOption
    • ConfigurableProductOptions
    • ConfigurableProductOptionsSelection
    • ConfigurableProductOptionsValues
    • ConfigurableProductOptionValue
    • ConfigurableProductReviewsArgs
    • ConfigurableVariant
    • ConfigurableWishlistItem
    • Country
    • CreateCompareListInput
    • CreateEmptyCartInput
    • CreateKlarnaPaymentsSessionInput
    • CreateKlarnaPaymentsSessionOutput
    • CreatePayflowProTokenOutput
    • CreateProductReviewInput
    • CreateProductReviewOutput
    • CreditCardDetailsInput
    • CreditMemo
    • CreditMemoItem
    • CreditMemoItemInterface
    • CreditMemoTotal
    • Currency
    • CustomAttributeMetadata
    • Customer
    • CustomerAddress
    • CustomerAddressAttribute
    • CustomerAddressAttributeInput
    • CustomerAddressInput
    • CustomerAddressRegion
    • CustomerAddressRegionInput
    • CustomerCreateInput
    • CustomerDownloadableProduct
    • CustomerDownloadableProducts
    • CustomerInput
    • CustomerOrder
    • CustomerOrders
    • CustomerOrdersArgs
    • CustomerOrdersFilterInput
    • CustomerOutput
    • CustomerPaymentTokens
    • CustomerReviewsArgs
    • CustomerToken
    • CustomerUpdateInput
    • CustomerWishlist_V2Args
    • CustomerWishlistsArgs
    • CustomizableAreaOption
    • CustomizableAreaValue
    • CustomizableCheckboxOption
    • CustomizableCheckboxValue
    • CustomizableDateOption
    • CustomizableDateValue
    • CustomizableDropDownOption
    • CustomizableDropDownValue
    • CustomizableFieldOption
    • CustomizableFieldValue
    • CustomizableFileOption
    • CustomizableFileValue
    • CustomizableMultipleOption
    • CustomizableMultipleValue
    • CustomizableOptionInput
    • CustomizableOptionInterface
    • CustomizableProductInterface
    • CustomizableRadioOption
    • CustomizableRadioValue
    • DeleteCompareListOutput
    • DeletePaymentTokenOutput
    • Discount
    • DownloadableCartItem
    • DownloadableCreditMemoItem
    • DownloadableInvoiceItem
    • DownloadableItemsLinks
    • DownloadableOrderItem
    • DownloadableProduct
    • DownloadableProductCartItemInput
    • DownloadableProductLinks
    • DownloadableProductLinksInput
    • DownloadableProductReviewsArgs
    • DownloadableProductSamples
    • DownloadableWishlistItem
    • EnteredOptionInput
    • EntityUrl
    • ExchangeRate
    • FilterEqualTypeInput
    • FilterMatchTypeInput
    • FilterRangeTypeInput
    • FilterStringTypeInput
    • FilterTypeInput
    • FixedProductTax
    • GenerateCustomerTokenAsAdminInput
    • GenerateCustomerTokenAsAdminOutput
    • GiftMessage
    • GiftMessageInput
    • GroupedProduct
    • GroupedProductItem
    • GroupedProductReviewsArgs
    • GroupedProductWishlistItem
    • HostedProInput
    • HostedProUrl
    • HostedProUrlInput
    • HttpQueryParameter
    • ImageSwatchData
    • Invoice
    • InvoiceItem
    • InvoiceItemInterface
    • InvoiceTotal
    • IsConfigSettingEnabledOutput
    • IsEmailAvailableOutput
    • ItemSelectedBundleOption
    • ItemSelectedBundleOptionValue
    • KeyValue
    • KlarnaInput
    • LayerFilter
    • LayerFilterItem
    • LayerFilterItemInterface
    • MagentoApiMethods
    • MediaGalleryEntry
    • MediaGalleryInterface
    • Money
    • Mutation
    • MutationAddBundleProductsToCartArgs
    • MutationAddConfigurableProductsToCartArgs
    • MutationAddDownloadableProductsToCartArgs
    • MutationAddProductsToCartArgs
    • MutationAddProductsToCompareListArgs
    • MutationAddProductsToWishlistArgs
    • MutationAddSimpleProductsToCartArgs
    • MutationAddVirtualProductsToCartArgs
    • MutationAddWishlistItemsToCartArgs
    • MutationApplyCouponToCartArgs
    • MutationAssignCompareListToCustomerArgs
    • MutationChangeCustomerPasswordArgs
    • MutationCreateCompareListArgs
    • MutationCreateCustomerAddressArgs
    • MutationCreateCustomerArgs
    • MutationCreateCustomerV2Args
    • MutationCreateEmptyCartArgs
    • MutationCreateKlarnaPaymentsSessionArgs
    • MutationCreatePayflowProTokenArgs
    • MutationCreatePaypalExpressTokenArgs
    • MutationCreateProductReviewArgs
    • MutationDeleteCompareListArgs
    • MutationDeleteCustomerAddressArgs
    • MutationDeletePaymentTokenArgs
    • MutationGenerateCustomerTokenArgs
    • MutationGenerateCustomerTokenAsAdminArgs
    • MutationHandlePayflowProResponseArgs
    • MutationMergeCartsArgs
    • MutationPlaceOrderArgs
    • MutationRemoveCouponFromCartArgs
    • MutationRemoveItemFromCartArgs
    • MutationRemoveProductsFromCompareListArgs
    • MutationRemoveProductsFromWishlistArgs
    • MutationReorderItemsArgs
    • MutationRequestPasswordResetEmailArgs
    • MutationResetPasswordArgs
    • MutationSendEmailToFriendArgs
    • MutationSetBillingAddressOnCartArgs
    • MutationSetGuestEmailOnCartArgs
    • MutationSetPaymentMethodAndPlaceOrderArgs
    • MutationSetPaymentMethodOnCartArgs
    • MutationSetShippingAddressesOnCartArgs
    • MutationSetShippingMethodsOnCartArgs
    • MutationSubscribeEmailToNewsletterArgs
    • MutationUpdateCartItemsArgs
    • MutationUpdateChatProfileArgs
    • MutationUpdateCustomerAddressArgs
    • MutationUpdateCustomerArgs
    • MutationUpdateCustomerEmailArgs
    • MutationUpdateCustomerV2Args
    • MutationUpdateProductsInWishlistArgs
    • MutationUpdateQuoteEmailArgs
    • Order
    • OrderAddress
    • OrderItem
    • OrderItemInterface
    • OrderItemOption
    • OrderPaymentMethod
    • OrderShipment
    • OrderTotal
    • PayflowExpressInput
    • PayflowLinkInput
    • PayflowLinkToken
    • PayflowLinkTokenInput
    • PayflowProInput
    • PayflowProResponseInput
    • PayflowProResponseOutput
    • PayflowProToken
    • PayflowProTokenInput
    • PayflowProUrlInput
    • PaymentMethodInput
    • PaymentToken
    • PaypalExpressInput
    • PaypalExpressToken
    • PaypalExpressTokenInput
    • PaypalExpressTokenOutput
    • PaypalExpressUrlList
    • PaypalExpressUrlsInput
    • PhysicalProductInterface
    • PickupLocation
    • PickupLocationFilterInput
    • PickupLocations
    • PickupLocationSortInput
    • PlaceOrderInput
    • PlaceOrderOutput
    • Price
    • PriceAdjustment
    • PriceRange
    • Product
    • ProductAttribute
    • ProductAttributeFilterInput
    • ProductAttributeSortInput
    • ProductDiscount
    • ProductFilterInput
    • ProductImage
    • ProductInfoInput
    • ProductInterface
    • ProductInterfaceReviewsArgs
    • ProductLinks
    • ProductLinksInterface
    • ProductMediaGalleryEntriesContent
    • ProductMediaGalleryEntriesVideoContent
    • ProductPrice
    • ProductPrices
    • ProductReview
    • ProductReviewRating
    • ProductReviewRatingInput
    • ProductReviewRatingMetadata
    • ProductReviewRatingsMetadata
    • ProductReviewRatingValueMetadata
    • ProductReviews
    • Products
    • ProductSortInput
    • ProductTierPrices
    • ProductVideo
    • Query
    • QueryAvailableStoresArgs
    • QueryCartArgs
    • QueryCategoriesArgs
    • QueryCategoryArgs
    • QueryCategoryListArgs
    • QueryCmsBlocksArgs
    • QueryCmsPageArgs
    • QueryCompareListArgs
    • QueryCountryArgs
    • QueryCustomAttributeMetadataArgs
    • QueryGetHostedProUrlArgs
    • QueryGetPayflowLinkTokenArgs
    • QueryIsEmailAvailableArgs
    • QueryOrderDataArgs
    • QueryPickupLocationsArgs
    • QueryProductsArgs
    • QueryRouteArgs
    • QueryUrlResolverArgs
    • Region
    • RemoveCouponFromCartInput
    • RemoveCouponFromCartOutput
    • RemoveItemFromCartInput
    • RemoveItemFromCartOutput
    • RemoveProductsFromCompareListInput
    • RemoveProductsFromWishlistOutput
    • ReorderItemsOutput
    • RevokeCustomerTokenOutput
    • RoutableInterface
    • SalesCommentItem
    • SalesItemInterface
    • Scalars
    • SearchResultPageInfo
    • SelectedBundleOption
    • SelectedBundleOptionValue
    • SelectedConfigurableOption
    • SelectedCustomizableOption
    • SelectedCustomizableOptionValue
    • SelectedPaymentMethod
    • SelectedShippingMethod
    • SendEmailToFriendInput
    • SendEmailToFriendOutput
    • SendEmailToFriendRecipient
    • SendEmailToFriendRecipientInput
    • SendEmailToFriendSender
    • SendEmailToFriendSenderInput
    • SendFriendConfiguration
    • SetBillingAddressOnCartInput
    • SetBillingAddressOnCartOutput
    • SetGuestEmailOnCartInput
    • SetGuestEmailOnCartOutput
    • SetPaymentMethodAndPlaceOrderInput
    • SetPaymentMethodOnCartInput
    • SetPaymentMethodOnCartInputs
    • SetPaymentMethodOnCartOutput
    • SetShippingAddressesOnCartInput
    • SetShippingAddressesOnCartOutput
    • SetShippingMethodsOnCartInput
    • SetShippingMethodsOnCartOutput
    • ShipmentItem
    • ShipmentItemInterface
    • ShipmentTracking
    • ShippingAddressInput
    • ShippingCartAddress
    • ShippingDiscount
    • ShippingHandling
    • ShippingMethodInput
    • SimpleCartItem
    • SimpleProduct
    • SimpleProductCartItemInput
    • SimpleProductReviewsArgs
    • SimpleWishlistItem
    • SortField
    • SortFields
    • StoreConfig
    • StorefrontProperties
    • SubscribeEmailToNewsletterOutput
    • SwatchData
    • SwatchDataInterface
    • SwatchLayerFilterItem
    • SwatchLayerFilterItemInterface
    • TaxItem
    • TextSwatchData
    • TierPrice
    • TrackingData
    • UpdateCartItemsInput
    • UpdateCartItemsOutput
    • UpdateProductsInWishlistOutput
    • UrlRewrite
    • VaultTokenInput
    • VirtualCartItem
    • VirtualProduct
    • VirtualProductCartItemInput
    • VirtualProductReviewsArgs
    • VirtualWishlistItem
    • Website
    • Wishlist
    • WishlistCartUserInputError
    • WishlistItem
    • WishlistItemInput
    • WishlistItemInterface
    • WishlistItems_V2Args
    • WishlistItems
    • WishlistItemUpdateInput
    • WishlistOutput
    • WishListUserInputError
  • Type Aliases
    • AddBundleProductsToCartMutation
    • AddBundleProductsToCartMutationVariables
    • AddConfigurableProductsToCartMutation
    • AddConfigurableProductsToCartMutationVariables
    • AddDownloadableProductsToCartMutation
    • AddDownloadableProductsToCartMutationVariables
    • AddProductsToCartInput
    • AddProductsToCartMutation
    • AddProductsToCartMutationVariables
    • AddProductsToWishlistMutation
    • AddProductsToWishlistMutationVariables
    • AddSimpleProductsToCartMutation
    • AddSimpleProductsToCartMutationVariables
    • AddVirtualProductsToCartMutation
    • AddVirtualProductsToCartMutationVariables
    • ApplyCouponToCartMutation
    • ApplyCouponToCartMutationVariables
    • AvailableStoresQuery
    • AvailableStoresQueryVariables
    • CartQuery
    • CartQueryVariables
    • CategoryListQuery
    • CategoryListQueryVariables
    • CategorySearchQuery
    • CategorySearchQueryVariables
    • ChangeCustomerPasswordMutation
    • ChangeCustomerPasswordMutationVariables
    • CmsBlockQuery
    • CmsBlockQueryVariables
    • CmsPageQuery
    • CmsPageQueryVariables
    • CountriesListQuery
    • CountriesListQueryVariables
    • CountryInformationQuery
    • CountryInformationQueryVariables
    • CreateCustomerAddressMutation
    • CreateCustomerAddressMutationVariables
    • CreateCustomerMutation
    • CreateCustomerMutationVariables
    • CreateEmptyCartMutation
    • CreateEmptyCartMutationVariables
    • CreateProductReviewMutation
    • CreateProductReviewMutationVariables
    • CurrencyQuery
    • CurrencyQueryVariables
    • CustomerAvailablePaymentMethodsQuery
    • CustomerAvailablePaymentMethodsQueryVariables
    • CustomerAvailableShippingMethodsQuery
    • CustomerAvailableShippingMethodsQueryVariables
    • CustomerCartQuery
    • CustomerCartQueryVariables
    • CustomerOrdersQuery
    • CustomerOrdersQueryVariables
    • CustomerProductReviewParams
    • CustomerProductReviewQuery
    • CustomerProductReviewQueryVariables
    • CustomerQuery
    • CustomerQueryVariables
    • CustomHeaders
    • CustomQuery
    • DeleteCustomerAddressMutation
    • DeleteCustomerAddressMutationVariables
    • Exact
    • GenerateCustomerTokenMutation
    • GenerateCustomerTokenMutationVariables
    • GetCustomerAddressesQuery
    • GetCustomerAddressesQueryVariables
    • GetOrdersSearchParams
    • GetProductSearchParams
    • GuestAvailablePaymentMethodsQuery
    • GuestAvailablePaymentMethodsQueryVariables
    • GuestAvailableShippingMethodsQuery
    • GuestAvailableShippingMethodsQueryVariables
    • InputMaybe
    • MakeMaybe
    • MakeOptional
    • Maybe
    • MergeCartsMutation
    • MergeCartsMutationVariables
    • PlaceOrderMutation
    • PlaceOrderMutationVariables
    • ProductDetailsQuery
    • ProductDetailsQueryVariables
    • ProductReviewQuery
    • ProductReviewQueryVariables
    • ProductReviewRatingsMetadataQuery
    • ProductReviewRatingsMetadataQueryVariables
    • ProductsListQuery
    • ProductsListQueryVariables
    • RelatedProductsQuery
    • RelatedProductsQueryVariables
    • RemoveCouponFromCartMutation
    • RemoveCouponFromCartMutationVariables
    • RemoveItemFromCartMutation
    • RemoveItemFromCartMutationVariables
    • RemoveProductsFromWishlistMutation
    • RemoveProductsFromWishlistMutationVariables
    • RequestPasswordResetEmailMutation
    • RequestPasswordResetEmailMutationVariables
    • ResetPasswordMutation
    • ResetPasswordMutationVariables
    • RevokeCustomerTokenMutation
    • RevokeCustomerTokenMutationVariables
    • RouteQuery
    • SetBillingAddressOnCartMutation
    • SetBillingAddressOnCartMutationVariables
    • SetGuestEmailOnCartMutation
    • SetGuestEmailOnCartMutationVariables
    • SetPaymentMethodOnCartMutation
    • SetPaymentMethodOnCartMutationVariables
    • SetShippingAddressesOnCartMutation
    • SetShippingAddressesOnCartMutationVariables
    • SetShippingMethodsOnCartMutation
    • SetShippingMethodsOnCartMutationVariables
    • StoreConfigQuery
    • StoreConfigQueryVariables
    • SubscribeEmailToNewsletterMutation
    • SubscribeEmailToNewsletterMutationVariables
    • UpdateCartItemsMutation
    • UpdateCartItemsMutationVariables
    • UpdateCustomerAddressMutation
    • UpdateCustomerAddressMutationVariables
    • UpdateCustomerEmailMutation
    • UpdateCustomerEmailMutationVariables
    • UpdateCustomerMutation
    • UpdateCustomerMutationVariables
    • UpsellProductsQuery
    • UpsellProductsQueryVariables
    • UrlResolverQuery
    • UrlResolverQueryVariables
    • WishlistQuery
    • WishlistQueryVariables

© 2023 Vue Storefront.

Contributing Support VSF v2 Docs