Home > @vue-storefront/magento-api
magento-api package
Api Client for Magento 2 integration for Vue Storefront 2.
Remarks
The @vue-storefront/magento-api
library includes Apollo Client, GraphQL operations and Middleware endpoints that allow you to communicate with Magento.
Functions
Variables
Variable | Description |
---|---|
addBundleProductsToCart | |
addProductToWishList | |
addSimpleProductsToCart | |
availableStores | Returns list of available stores |
cartTotalQty | |
changeCustomerPassword | Changes password of the current customer. To override the default query, use the changeCustomerPassword query key. |
createCustomer | Registers a new customer. To override the default query, use the createCustomer query key. |
createEmptyCart | |
createProductReview | Creates a new product review |
customer | Returns the information about the current customer. To override the default query, use the customer query key. |
customerOrders | Returns customer orders. To override the default query, use the customerOrders query key. |
customerProductReview | Returns product reviews created by the current customer |
customMutation | |
customQuery | |
generateCustomerToken | Logs in the customer based on provided username and password. To override the default query, use the generateCustomerToken query key. |
getAvailableCustomerPaymentMethods | |
getAvailableShippingMethods | |
mergeCarts | |
productReview | Returns reviews of the provided product |
productReviewRatingsMetadata | Returns additional product reviews data |
removeProductsFromWishlist | |
revokeCustomerToken | Logs out the current customer. To override the default query, use the revokeCustomerToken query key. |
setBillingAddressOnCart | |
updateCustomer | Updates the data of the current customer. To override the default query, use the updateCustomer query key. |
updateCustomerEmail | |
upsellProduct | Returns upsell products matching the provided parameters. To override the default query, use the upsellProducts query key. |
wishlist | |
wishlistItemsCount |