Home > @vsf-enterprise/commercetools-api > ApiMethods

# ApiMethods interface

All API endpoints available in the integration out of the box

Signature:

export interface ApiMethods 

# Methods

Method Description
addBillingAddress(params, customQuery) See the addBillingAddress() function
addMultipleToMyShoppingList(params, customQuery) See the addMultipleToMyShoppingList() function
addReview(params, customQuery) See the addReview() function
addShippingAddress(params, customQuery) See the addShippingAddress() function
addToCart(cart, product, customQuery) See the addToCart() function
addToMyShoppingList(params, customQuery) See the addToMyShoppingList() function
applyCartCoupon(params, discountCode, customQuery) See the applyCartCoupon() function
createCart(cartDraft, customQuery) See the createCart() function
createMyOrderFromCart(draft, customQuery) See the createMyOrderFromCart() function
createMyShoppingList(draft, customQuery) See the createMyShoppingList() function
customerChangeMyPassword(version, currentPassword, newPassword) See the customerChangeMyPassword() function
customerCreatePasswordResetToken(email, expose, customQuery) See the customerCreatePasswordResetToken function
customerResetPassword(tokenValue, newPassword, customQuery) See the customerResetPassword() function
customerSignMeIn(draft) See the customerSignMeIn() function
customerSignMeUp(draft) See the customerSignMeUp() function
customerSignOut() See the customerSignOut() function
customerUpdateMe(currentUser, updatedUserData, customQuery) See the customerUpdateMe() function
deleteBillingAddress(params, customQuery) See the deleteBillingAddress() function
deleteCart(params, customQuery) See the deleteCart() function
deleteShippingAddress(params, customQuery) See the deleteShippingAddress() function
getCart(cartId) See the getCart() function
getCategory(params, customQuery) See the getCategory() function
getChannel(params) See the getChannel() function
getFacetCategories(params, customQuery) See the getFacetCategories() function
getFacetProductProjection(params, customQuery) See the getFacetProductProjection() function
getInventory(params, customQuery) See the getInventory() function
getMe(params, customQuery) See the getMe() function
getMyShoppingList(customQuery) See the getMyShoppingList() function
getOrders(params, customQuery) See the getOrders() function
getProduct(params, customQuery) See the getProduct() function
getReview(params, customQuery) See the getReview() function
getShippingMethods(cartId, customQuery) See the getShippingMethods() function
getStores(params) See the getStores() function
isGuest() See the isGuest() function
isLoggedIn() See the isLoggedIn() function
removeCartCoupon(params, discountCode, customQuery) See the removeCartCoupon() function
removeFromCart(cart, product, customQuery) See the removeFromCart() function
removeFromMyShoppingList(params, customQuery) See the removeFromMyShoppingList() function
setDefaultBillingAddress(params, customQuery) See the setDefaultBillingAddress() function
setDefaultShippingAddress(params, customQuery) See the setDefaultShippingAddress() function
updateBillingAddress(params, customQuery) See the updateBillingAddress() function
updateCart(params, customQuery) See the updateCart() function
updateCartItemChannel(cart, product, customQuery) See the function
updateCartQuantity(cart, product, customQuery) See the updateCartQuantity() function
updateShippingAddress(params, customQuery) See the updateShippingAddress() function
updateShippingDetails(cart, shippingDetails, customQuery) See the updateShippingDetails() function