You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
@vsf-enterprise/commercetools-api
This is the API reference documentation for the @vsf-enterprise/commercetools-api library. It contains all of the available methods, interfaces, and other implementation details for interacting with the @vsf-enterprise/commercetools-api API.
Functions
- addBillingAddress
- addMultipleToMyShoppingList
- addReview
- addShippingAddress
- addToCart
- addToMyShoppingList
- applyCartCoupon
- createCart
- createMyOrderFromCart
- createMyShoppingList
- customerChangeMyPassword
- customerCreatePasswordResetToken
- customerResetPassword
- customerSignMeIn
- customerSignMeUp
- customerSignOut
- customerUpdateMe
- deleteBillingAddress
- deleteCart
- deleteReview
- deleteShippingAddress
- getCart
- getCategory
- getChannel
- getFacet
- getFacetCategories
- getFacetProductProjection
- getInventory
- getMe
- getMyShoppingList
- getOrders
- getProduct
- getReview
- getShippingMethods
- getShoppingList
- getStores
- isAnonymousSession
- isGuest
- isLoggedIn
- isUserSession
- removeCartCoupon
- removeFromCart
- removeFromMyShoppingList
- setDefaultBillingAddress
- setDefaultBillingAddressAction
- setDefaultShippingAddress
- setDefaultShippingAddressAction
- updateBillingAddress
- updateCart
- updateCartQuantity
- updateMyCustomer
- updateShippingAddress
- updateShippingDetails
Variables
- addBillingAddressDefaultQuery
- addBillingAddressMutation
- addMultipleToMyShoppingListDefaultQuery
- AddressFragment
- addReviewDefaultQuery
- addShippingAddressDefaultQuery
- addShippingAddressMutation
- addToMyShoppingListDefaultQuery
- CartFragment
- ChannelFragment
- createCartDefaultQuery
- createCartMutation
- createMyOrderFromCartDefaultQuery
- createMyOrderFromCartMutation
- createMyShoppingListDefaultQuery
- CT_COOKIE_NAME
- customerChangeMyPasswordDefaultQuery
- customerChangeMyPasswordMutation
- customerCreatePasswordResetTokenDefaultQuery
- CustomerFragment
- customerResetPasswordDefaultQuery
- customerResetPasswordMutation
- customerSignMeInDefaultQuery
- customerSignMeInMutation
- customerSignMeUpDefaultQuery
- customerSignMeUpMutation
- customerUpdateMeDefaultQuery
- customerUpdateMeMutation
- DefaultCartFragment
- DefaultChannelFragment
- DefaultCustomerFragment
- DefaultInitiatorFragment
- DefaultInventoryEntriesQueryResultFragment
- DefaultInventoryEntryFragment
- DefaultLineItemFragment
- DefaultOrderFragment
- DefaultReviewFragment
- DefaultStoreFragment
- DefaultStoreQueryResultFragment
- deleteBillingAddressDefaultQuery
- deleteBillingAddressMutation
- deleteCartDefaultQuery
- deleteCartMutation
- deleteReviewDefaultQuery
- deleteShippingAddressDefaultQuery
- deleteShippingAddressMutation
- getBasicProfileQuery
- getCartDefaultQuery
- getCartQuery
- getCategoryDefaultQuery
- getChannelDefaultQuery
- getFacetCategoriesDefaultQuery
- getFacetProductProjectionDefaultQuery
- getFullProfileQuery
- getInventoryDefaultQuery
- getMeBasicProfileDefaultQuery
- getMeFullProfileDefaultQuery
- getMyOrdersQuery
- getMyShoppingListDefaultQuery
- getOrdersDefaultQuery
- getProductDefaultQuery
- getReviewDefaultQuery
- getShippingMethodsDefaultQuery
- getShoppingListDefaultQuery
- getStoresDefaultQuery
- InitiatorFragment
- inventoryEntriesQuery
- InventoryEntriesQueryResultFragment
- InventoryEntryFragment
- LineItemFragment
- LocalizedStringFragment
- OrderFragment
- ProductPriceFragment
- productProjectionsSearchQuery
- productsQuery
- ReferenceFragment
- setDefaultBillingAddressDefaultQuery
- setDefaultBillingAddressMutation
- setDefaultShippingAddressDefaultQuery
- setDefaultShippingAddressMutation
- ShippingMethodFragment
- shippingMethodsQuery
- StoreFragment
- StoreQueryResultFragment
- storesQuery
- updateBillingAddressDefaultQuery
- updateBillingAddressMutation
- updateCartDefaultQuery
- updateCartMutation
- updateMyCustomerDefaultQuery
- updateMyCustomerMutation
- updateShippingAddressDefaultQuery
- updateShippingAddressMutation
- VSF_CHANNEL_COOKIE
- VSF_COUNTRY_COOKIE
- VSF_CURRENCY_COOKIE
- VSF_CUSTOMER_GROUP_COOKIE
- VSF_CUSTOMER_GROUP_NO_GROUP_VALUE
- VSF_LOCALE_COOKIE
- VSF_STORE_COOKIE
Interfaces
- AddBillingAddressParams
- AddMultipleToMyShoppingListParams
- AddReviewParams
- AddShippingAddressParams
- AddToCartParams
- AddToCartProductParams
- AddToMyShoppingListParams
- ApiConfig
- ApiMethods
- ApplyCartCouponParams
- Auth
- BaseSearch
- CartData
- CategoryWhereSearch
- ChannelsWhereSearch
- ClientInstance
- CommercetoolsContext
- Config
- Context
- CookiesConfig
- CreateCartParams
- CreateMyOrderFromCartParams
- CreateMyShoppingListParams
- CustomerUpdateCurrentUser
- DeleteBillingAddressParams
- DeleteCartParams
- DeleteReviewParams
- DeleteShippingAddressParams
- FetchResult
- Filter
- FilterOption
- FlowOptions
- GetChannelParams
- GetFacetProductProjectionParams
- GetInventoryParams
- GetMeParams
- GetOrdersParams
- GetProductParams
- GetReviewParams
- IntegrationContext
- LineItemIdentifier
- LocaleItem
- OrderWhereSearch
- ProductIdentifier
- ProductWhereSearch
- RemoveCartCouponParams
- RemoveFromCartParams
- RemoveFromMyShoppingListParams
- ServerApiConfiguration
- SetDefaultBillingAddressParams
- SetDefaultShippingAddressParams
- SetupConfig
- SetupContext
- ShoppingListData
- ShoppingListWhereSearch
- Token
- UpdateBillingAddressParams
- UpdateCartParams
- UpdateCartQuantityParams
- UpdateCartQuantityProductParams
- UpdatedUserData
- UpdateMyCustomerParams
- UpdateShippingAddressParams
- UpdateShippingDetailsParams
Type Aliases
- AddBillingAddressResponse
- AddMultipleToMyShoppingListResponse
- AddReviewResponse
- AddShippingAddressResponse
- AddToCartResponse
- AddToMyShoppingListResponse
- ApiResponseWrapper
- ApplyCartCouponResponse
- BillingAddress
- BillingAddressAddParams
- BillingAddressDeleteParams
- BillingAddressResponse
- BillingAddressSetDefaultParams
- BillingAddressUpdateParams
- CartDetails
- CartMutationResponse
- CartQueryResponse
- CartResponse
- ChangeMyPasswordResponse
- ChannelSearchParams
- ContextualizedEndpoints
- CreateCartResponse
- CreateMyOrderFromCartResponse
- CreateMyShoppingListResponse
- CreatePasswordResetTokenResponse
- CustomerChangeMyPasswordResponse
- CustomerCreatePasswordResetTokenResponse
- CustomerResetPasswordResponse
- CustomerSignMeInResponse
- CustomerSignMeUpResponse
- CustomerUpdateMeResponse
- CustomQuery
- DeleteBillingAddressResponse
- DeleteCartResponse
- DeleteReviewResponse
- DeleteShippingAddressResponse
- GetCartResponse
- GetCategoryResponse
- GetChannelResponse
- GetFacetCategoriesResponse
- GetFacetProductProjectionResponse
- GetInventoryResponse
- GetMeResponse
- GetMyShoppingListResponse
- GetOrdersResponse
- GetProductResponse
- GetReviewResponse
- GetShippingMethodsResponse
- GetStoresResponse
- InventorySearchParams
- isGuestResponse
- isLoggedInResponse
- MutationResponse
- OrderMutationResponse
- OrderQueryResponse
- OrderResponse
- QueryResponse
- RemoveCartCouponResponse
- RemoveFromCartResponse
- RemoveFromMyShoppingListResponse
- ResetPasswordResponse
- ReviewAddParams
- ReviewResponse
- ReviewSearchParams
- SetDefaultBillingAddressResponse
- SetDefaultShippingAddressResponse
- ShippingAddress
- ShippingAddressAddParams
- ShippingAddressDeleteParams
- ShippingAddressResponse
- ShippingAddressSetDefaultParams
- ShippingAddressUpdateParams
- ShippingMethodsResponse
- SignInResponse
- UpdateBillingAddressResponse
- UpdateCartQuantityResponse
- UpdateCartResponse
- UpdateMyCustomerResponse
- UpdateShippingAddressResponse
- UpdateShippingDetailsResponse
- User
- VSFLogger
- WishlistResponse