@vsf-enterprise/magento-types
This is the API reference documentation for the @vsf-enterprise/magento-types library. It contains all of the available methods, interfaces, and other implementation details for interacting with the @vsf-enterprise/magento-types API.
Type Aliases
- AddBundleProductsToCartInput
- AddBundleProductsToCartOutput
- AddConfigurableProductsToCartInput
- AddConfigurableProductsToCartOutput
- AddDownloadableProductsToCartInput
- AddDownloadableProductsToCartOutput
- AddProductsToCartOutput
- AddProductsToCompareListInput
- AddProductsToWishlistOutput
- AddSimpleProductsToCartInput
- AddSimpleProductsToCartOutput
- AddVirtualProductsToCartInput
- AddVirtualProductsToCartOutput
- AddWishlistItemsToCartOutput
- Aggregation
- AggregationOption
- AggregationOptionInterface
- AggregationsCategoryFilterInput
- AggregationsFilterInput
- ApplePayConfig
- ApplePayMethodInput
- AppliedCoupon
- ApplyCouponToCartInput
- ApplyCouponToCartOutput
- AreaInput
- AssignCompareListToCustomerOutput
- Attribute
- AttributeEntityTypeEnum
- AttributeFilterInput
- AttributeFrontendInputEnum
- AttributeInput
- AttributeInputSelectedOption
- AttributeMetadata
- AttributeMetadataError
- AttributeMetadataErrorType
- AttributeOption
- AttributeOptionMetadata
- AttributeSelectedOption
- AttributeSelectedOptionInterface
- AttributeSelectedOptions
- AttributesFormOutput
- AttributesMetadataOutput
- AttributeValue
- AttributeValueInput
- AttributeValueInterface
- AvailablePaymentMethod
- AvailableShippingMethod
- BatchMutationStatus
- BestsellersProductOutput
- BillingAddressInput
- BillingAddressPaymentSourceInput
- BillingCartAddress
- BraintreeCcVaultInput
- BraintreeInput
- BraintreeVaultInput
- Breadcrumb
- BundleCartItem
- BundleCreditMemoItem
- BundleInvoiceItem
- BundleItem
- BundleItemOption
- BundleOptionInput
- BundleOrderItem
- BundleProduct
- BundleProductCartItemInput
- BundleProductCustom_AttributesV2Args
- BundleProductReviewsArgs
- BundleShipmentItem
- BundleWishlistItem
- ButtonStyles
- CancellationReason
- CancelOrderError
- CancelOrderErrorCode
- CancelOrderInput
- CancelOrderOutput
- Card
- CardBin
- CardPaymentSourceInput
- CardPaymentSourceOutput
- Cart
- CartAddressCountry
- CartAddressInput
- CartAddressInterface
- CartAddressRegion
- CartDiscount
- CartDiscountType
- CartItemError
- CartItemErrorType
- CartItemInput
- CartItemInterface
- CartItemPrices
- CartItemQuantity
- CartItems
- CartItemSelectedOptionValuePrice
- CartItemsV2Args
- CartItemUpdateInput
- CartPrices
- CartRule
- CartTaxItem
- CartUserInputError
- CartUserInputErrorType
- CatalogAttributeApplyToEnum
- CatalogAttributeMetadata
- CatalogRule
- CategoryFilterInput
- CategoryInterface
- CategoryInterfaceProductsArgs
- CategoryProducts
- CategoryResult
- CategoryTree
- CategoryTreeProductsArgs
- CheckoutAgreement
- CheckoutAgreementMode
- CheckoutUserInputError
- CheckoutUserInputErrorCodes
- CmsBlock
- CmsBlocks
- CmsPage
- ColorSwatchData
- ComparableAttribute
- ComparableItem
- CompareList
- ComplexTextValue
- ConfigurableAttributeOption
- ConfigurableCartItem
- ConfigurableOptionAvailableForSelection
- ConfigurableOrderItem
- ConfigurableProduct
- ConfigurableProductCartItemInput
- ConfigurableProductConfigurable_Product_Options_SelectionArgs
- ConfigurableProductCustom_AttributesV2Args
- ConfigurableProductOption
- ConfigurableProductOptions
- ConfigurableProductOptionsSelection
- ConfigurableProductOptionsValues
- ConfigurableProductOptionValue
- ConfigurableProductReviewsArgs
- ConfigurableVariant
- ConfigurableWishlistItem
- ConfirmationStatusEnum
- ConfirmCancelOrderInput
- ConfirmEmailInput
- ContactUsInput
- ContactUsOutput
- Country
- CountryCodeEnum
- CreateCompareListInput
- CreateEmptyCartInput
- CreateGuestCartInput
- CreateGuestCartOutput
- CreatePayflowProTokenOutput
- CreatePaymentOrderInput
- CreatePaymentOrderOutput
- CreateProductReviewInput
- CreateProductReviewOutput
- CreateVaultCardPaymentTokenInput
- CreateVaultCardPaymentTokenOutput
- CreateVaultCardSetupTokenInput
- CreateVaultCardSetupTokenOutput
- CreditCardDetailsInput
- CreditMemo
- CreditMemoItem
- CreditMemoItemInterface
- CreditMemoTotal
- Currency
- CurrencyEnum
- CustomAttributeMetadata
- CustomAttributeMetadataInterface
- CustomAttributeOptionInterface
- Customer
- CustomerAddress
- CustomerAddressAttribute
- CustomerAddressAttributeInput
- CustomerAddressCustom_AttributesV2Args
- CustomerAddresses
- CustomerAddressesV2Args
- CustomerAddressInput
- CustomerAddressRegion
- CustomerAddressRegionInput
- CustomerAttributeMetadata
- CustomerCreateInput
- CustomerCustom_AttributesArgs
- CustomerDownloadableProduct
- CustomerDownloadableProducts
- CustomerGroup
- CustomerInput
- CustomerOrder
- CustomerOrders
- CustomerOrdersArgs
- CustomerOrdersFilterInput
- CustomerOrderSortableField
- CustomerOrderSortInput
- CustomerOutput
- CustomerPaymentTokens
- CustomerProductReviewParams
- CustomerReviewsArgs
- CustomerToken
- CustomerUpdateInput
- CustomerWishlist_V2Args
- CustomerWishlistsArgs
- CustomHeaders
- CustomizableAreaOption
- CustomizableAreaValue
- CustomizableCheckboxOption
- CustomizableCheckboxValue
- CustomizableDateOption
- CustomizableDateTypeEnum
- CustomizableDateValue
- CustomizableDropDownOption
- CustomizableDropDownValue
- CustomizableFieldOption
- CustomizableFieldValue
- CustomizableFileOption
- CustomizableFileValue
- CustomizableMultipleOption
- CustomizableMultipleValue
- CustomizableOptionInput
- CustomizableOptionInterface
- CustomizableProductInterface
- CustomizableRadioOption
- CustomizableRadioValue
- CustomQuery
- DeleteCompareListOutput
- DeletePaymentTokenOutput
- Discount
- DownloadableCartItem
- DownloadableCreditMemoItem
- DownloadableFileTypeEnum
- DownloadableInvoiceItem
- DownloadableItemsLinks
- DownloadableOrderItem
- DownloadableProduct
- DownloadableProductCartItemInput
- DownloadableProductCustom_AttributesV2Args
- DownloadableProductLinks
- DownloadableProductLinksInput
- DownloadableProductReviewsArgs
- DownloadableProductSamples
- DownloadableWishlistItem
- EnteredOptionInput
- EntityUrl
- Error_2
- ErrorInterface
- EstimateAddressInput
- EstimateTotalsInput
- EstimateTotalsOutput
- Exact
- ExchangeRate
- FilterEqualTypeInput
- FilterMatchTypeEnum
- FilterMatchTypeInput
- FilterRangeTypeInput
- FilterStringTypeInput
- FilterTypeInput
- FixedProductTax
- FixedProductTaxDisplaySettings
- GenerateCustomerTokenAsAdminInput
- GenerateCustomerTokenAsAdminOutput
- GetOrdersSearchParams
- GetPaymentSdkOutput
- GetProductSearchParams
- GiftMessage
- GiftMessageInput
- GooglePayButtonStyles
- GooglePayConfig
- GooglePayMethodInput
- GroupedProduct
- GroupedProductCustom_AttributesV2Args
- GroupedProductItem
- GroupedProductReviewsArgs
- GroupedProductWishlistItem
- GuestOrderCancelInput
- HostedFieldsConfig
- HostedFieldsInput
- HostedProInput
- HostedProUrl
- HostedProUrlInput
- HttpQueryParameter
- ImageSwatchData
- Incremental
- InputFilterEnum
- InputMaybe
- InsufficientStockError
- InternalError
- Invoice
- InvoiceItem
- InvoiceItemInterface
- InvoiceTotal
- IsEmailAvailableOutput
- ItemSelectedBundleOption
- ItemSelectedBundleOptionValue
- KeyValue
- LayerFilter
- LayerFilterItem
- LayerFilterItemInterface
- MakeEmpty
- MakeMaybe
- MakeOptional
- Maybe
- MediaGalleryEntry
- MediaGalleryInterface
- MessageStyleLogo
- MessageStyles
- Money
- MpFilters
- Mutation
- MutationAddBundleProductsToCartArgs
- MutationAddConfigurableProductsToCartArgs
- MutationAddDownloadableProductsToCartArgs
- MutationAddProductsToCartArgs
- MutationAddProductsToCompareListArgs
- MutationAddProductsToWishlistArgs
- MutationAddSimpleProductsToCartArgs
- MutationAddVirtualProductsToCartArgs
- MutationAddWishlistItemsToCartArgs
- MutationApplyCouponToCartArgs
- MutationAssignCompareListToCustomerArgs
- MutationAssignCustomerToGuestCartArgs
- MutationCancelOrderArgs
- MutationChangeCustomerPasswordArgs
- MutationConfirmCancelOrderArgs
- MutationConfirmEmailArgs
- MutationContactUsArgs
- MutationCreateBraintreePayPalVaultClientTokenArgs
- MutationCreateCompareListArgs
- MutationCreateCustomerAddressArgs
- MutationCreateCustomerArgs
- MutationCreateCustomerV2Args
- MutationCreateEmptyCartArgs
- MutationCreateGuestCartArgs
- MutationCreatePayflowProTokenArgs
- MutationCreatePaymentOrderArgs
- MutationCreatePaypalExpressTokenArgs
- MutationCreateProductReviewArgs
- MutationCreateVaultCardPaymentTokenArgs
- MutationCreateVaultCardSetupTokenArgs
- MutationDeleteCompareListArgs
- MutationDeleteCustomerAddressArgs
- MutationDeletePaymentTokenArgs
- MutationEstimateShippingMethodsArgs
- MutationEstimateTotalsArgs
- MutationGenerateCustomerTokenArgs
- MutationGenerateCustomerTokenAsAdminArgs
- MutationHandlePayflowProResponseArgs
- MutationMergeCartsArgs
- MutationPlaceOrderArgs
- MutationRemoveCouponFromCartArgs
- MutationRemoveItemFromCartArgs
- MutationRemoveProductsFromCompareListArgs
- MutationRemoveProductsFromWishlistArgs
- MutationReorderItemsArgs
- MutationRequestGuestOrderCancelArgs
- MutationRequestPasswordResetEmailArgs
- MutationResendConfirmationEmailArgs
- MutationResetPasswordArgs
- MutationSendEmailToFriendArgs
- MutationSetBillingAddressOnCartArgs
- MutationSetGuestEmailOnCartArgs
- MutationSetPaymentMethodAndPlaceOrderArgs
- MutationSetPaymentMethodOnCartArgs
- MutationSetShippingAddressesOnCartArgs
- MutationSetShippingMethodsOnCartArgs
- MutationSubscribeEmailToNewsletterArgs
- MutationSyncPaymentOrderArgs
- MutationUpdateCartItemsArgs
- MutationUpdateCustomerAddressArgs
- MutationUpdateCustomerArgs
- MutationUpdateCustomerEmailArgs
- MutationUpdateCustomerV2Args
- MutationUpdateProductsInWishlistArgs
- NoSuchEntityUidError
- Order
- OrderActionType
- OrderAddress
- OrderCustomerInfo
- OrderInformationInput
- OrderItem
- OrderItemInterface
- OrderItemOption
- OrderItemPrices
- OrderPaymentMethod
- OrderShipment
- OrderTokenInput
- OrderTotal
- PayflowExpressInput
- PayflowLinkInput
- PayflowLinkMode
- PayflowLinkToken
- PayflowLinkTokenInput
- PayflowProInput
- PayflowProResponseInput
- PayflowProResponseOutput
- PayflowProToken
- PayflowProTokenInput
- PayflowProUrlInput
- PaymentCommonConfig
- PaymentConfigItem
- PaymentConfigOutput
- PaymentLocation
- PaymentMethodInput
- PaymentOrderOutput
- PaymentSdkParamsItem
- PaymentSourceDetails
- PaymentSourceInput
- PaymentSourceOutput
- PaymentToken
- PaymentTokenTypeEnum
- PaypalExpressInput
- PaypalExpressToken
- PaypalExpressTokenInput
- PaypalExpressTokenOutput
- PaypalExpressUrlList
- PaypalExpressUrlsInput
- PhysicalProductInterface
- PickupLocation
- PickupLocationFilterInput
- PickupLocations
- PickupLocationSortInput
- PlaceOrderError
- PlaceOrderErrorCodes
- PlaceOrderInput
- PlaceOrderOutput
- Price
- PriceAdjustment
- PriceAdjustmentCodesEnum
- PriceAdjustmentDescriptionEnum
- PriceDetails
- PriceRange
- PriceTypeEnum
- PriceViewEnum
- ProductAttribute
- ProductAttributeFilterInput
- ProductAttributeSortInput
- ProductCustomAttributes
- ProductDiscount
- ProductFilterInput
- ProductImage
- ProductImageThumbnail
- ProductInfoInput
- ProductInterface
- ProductInterfaceCustom_AttributesV2Args
- ProductInterfaceReviewsArgs
- ProductLinks
- ProductLinksInterface
- ProductMediaGalleryEntriesContent
- ProductMediaGalleryEntriesVideoContent
- ProductPrice
- ProductPrices
- ProductReview
- ProductReviewRating
- ProductReviewRatingInput
- ProductReviewRatingMetadata
- ProductReviewRatingsMetadata
- ProductReviewRatingValueMetadata
- ProductReviews
- Products
- ProductsAggregationsArgs
- ProductSortInput
- ProductStockStatus
- ProductTierPrices
- ProductVideo
- Query
- QueryAttributesFormArgs
- QueryAttributesListArgs
- QueryAvailableStoresArgs
- QueryCartArgs
- QueryCategoriesArgs
- QueryCategoryArgs
- QueryCategoryListArgs
- QueryCmsBlocksArgs
- QueryCmsPageArgs
- QueryCompareListArgs
- QueryCountryArgs
- QueryCustomAttributeMetadataArgs
- QueryCustomAttributeMetadataV2Args
- QueryGetHostedProUrlArgs
- QueryGetPayflowLinkTokenArgs
- QueryGetPaymentConfigArgs
- QueryGetPaymentOrderArgs
- QueryGetPaymentSdkArgs
- QueryGuestOrderArgs
- QueryGuestOrderByTokenArgs
- QueryIsEmailAvailableArgs
- QueryMpSmtpBestsellersArgs
- QueryPickupLocationsArgs
- QueryProductsArgs
- QueryRecaptchaFormConfigArgs
- QueryRouteArgs
- QueryUrlResolverArgs
- QuoteItemsSortInput
- ReCaptchaConfigOutput
- ReCaptchaConfiguration
- ReCaptchaConfigurationV3
- ReCaptchaFormEnum
- ReCaptchaTypeEmum
- Region
- RemoveCouponFromCartInput
- RemoveCouponFromCartOutput
- RemoveItemFromCartInput
- RemoveItemFromCartOutput
- RemoveProductsFromCompareListInput
- RemoveProductsFromWishlistOutput
- ReorderItemsOutput
- RevokeCustomerTokenOutput
- RoutableInterface
- RoutableUrl
- Route
- RouteQuery
- SalesCommentItem
- SalesItemInterface
- Scalars
- ScopeTypeEnum
- SdkParams
- SearchResultPageInfo
- SearchSuggestion
- SelectedBundleOption
- SelectedBundleOptionValue
- SelectedConfigurableOption
- SelectedCustomizableOption
- SelectedCustomizableOptionValue
- SelectedPaymentMethod
- SelectedShippingMethod
- SendEmailToFriendInput
- SendEmailToFriendOutput
- SendEmailToFriendRecipient
- SendEmailToFriendRecipientInput
- SendEmailToFriendSender
- SendEmailToFriendSenderInput
- SendFriendConfiguration
- SetBillingAddressOnCartInput
- SetBillingAddressOnCartOutput
- SetGuestEmailOnCartInput
- SetGuestEmailOnCartOutput
- SetPaymentMethodAndPlaceOrderInput
- SetPaymentMethodOnCartInput
- SetPaymentMethodOnCartOutput
- SetShippingAddressesOnCartInput
- SetShippingAddressesOnCartOutput
- SetShippingMethodsOnCartInput
- SetShippingMethodsOnCartOutput
- ShipBundleItemsEnum
- ShipmentItem
- ShipmentItemInterface
- ShipmentTracking
- ShippingAddressInput
- ShippingCartAddress
- ShippingDiscount
- ShippingHandling
- ShippingMethodInput
- SimpleCartItem
- SimpleProduct
- SimpleProductCartItemInput
- SimpleProductCustom_AttributesV2Args
- SimpleProductReviewsArgs
- SimpleWishlistItem
- SmartButtonMethodInput
- SmartButtonsConfig
- SmtpBestsellersOutput
- SortEnum
- SortField
- SortFields
- SortQuoteItemsEnum
- StoreConfig
- StorefrontProperties
- SubscribeEmailToNewsletterOutput
- SubscriptionStatusesEnum
- SwatchData
- SwatchDataInterface
- SwatchInputTypeEnum
- SwatchLayerFilterItem
- SwatchLayerFilterItemInterface
- SyncPaymentOrderInput
- TaxItem
- TaxWrappingEnum
- TextSwatchData
- ThreeDsMode
- TierPrice
- UpdateCartItemsInput
- UpdateCartItemsOutput
- UpdateProductsInWishlistOutput
- UrlRewrite
- UrlRewriteEntityTypeEnum
- UseInLayeredNavigationOptions
- ValidationRule
- ValidationRuleEnum
- VaultConfigOutput
- VaultCreditCardConfig
- VaultMethodInput
- VaultSetupTokenInput
- VaultTokenInput
- VirtualCartItem
- VirtualProduct
- VirtualProductCartItemInput
- VirtualProductCustom_AttributesV2Args
- VirtualProductReviewsArgs
- VirtualWishlistItem
- Website
- Wishlist
- WishlistCartUserInputError
- WishlistCartUserInputErrorType
- WishlistItem
- WishlistItemInput
- WishlistItemInterface
- WishlistItems_V2Args
- WishlistItems
- WishlistItemUpdateInput
- WishlistOutput
- WishListUserInputError
- WishListUserInputErrorType