@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
- addDiscountCodeAction
- addLineItemAction
- addMultipleToMyShoppingList
- addPayment
- addPaymentAction
- addProductReview
- addShippingAddress
- addToCart
- addToMyShoppingList
- applyCartCoupon
- changeCustomerEmailAction
- createAddLineItemAction
- createCart
- createChangeLineItemQuantityAction
- createMyOrderFromCart
- createMyShoppingList
- createRemoveLineItemAction
- customerChangePassword
- customerCreatePasswordResetToken
- customerResetPassword
- customerUpdateMe
- deleteBillingAddress
- deleteCart
- deleteProductReview
- deleteShippingAddress
- getCategories
- getChannel
- getFacet
- getFacetCategories
- getFacetProductProjection
- getInventory
- getMe
- getMyShoppingList
- getOrders
- getProductReviews
- getProducts
- getShippingMethods
- getShoppingList
- getStores
- isAnonymousSession
- isGuest
- isLoggedIn
- isUserSession
- removeCartCoupon
- removeDiscountCodeAction
- removeFromCart
- removeFromMyShoppingList
- setBillingAddressAction
- setCustomerDateOfBirthAction
- setCustomerEmail
- setCustomerFirstNameAction
- setCustomerLastNameAction
- setDefaultBillingAddress
- setDefaultBillingAddressAction
- setDefaultShippingAddress
- setDefaultShippingAddressAction
- setLineItemSupplyChannelAction
- setShippingAddressAction
- setShippingMethodAction
- setShippingMethodByKey
- signIn
- signOut
- signUp
- updateBillingAddress
- updateCart
- updateCartItemChannel
- updateCartQuantity
- updateCustomer
- updateShippingAddress
- updateShippingDetails
Variables
- addBillingAddressDefaultQuery
- addBillingAddressMutation
- addMultipleToMyShoppingListDefaultQuery
- AddressFragment
- addReview
- addReviewDefaultQuery
- addShippingAddressDefaultQuery
- addShippingAddressMutation
- addToMyShoppingListDefaultQuery
- CartFragment
- ChannelFragment
- createCartDefaultQuery
- createCartMutation
- createMyOrderFromCartDefaultQuery
- createMyOrderFromCartMutation
- createMyShoppingListDefaultQuery
- CT_COOKIE_NAME
- customerChangeMyPassword
- customerChangeMyPasswordDefaultQuery
- customerChangeMyPasswordMutation
- customerCreatePasswordResetTokenDefaultQuery
- CustomerFragment
- customerResetPasswordDefaultQuery
- customerResetPasswordMutation
- customerSignMeIn
- customerSignMeInDefaultQuery
- customerSignMeInMutation
- customerSignMeUp
- customerSignMeUpDefaultQuery
- customerSignMeUpMutation
- customerSignOut
- customerUpdateMeDefaultQuery
- customerUpdateMeMutation
- DefaultCartFragment
- DefaultChannelFragment
- DefaultCustomerFragment
- DefaultInitiatorFragment
- DefaultInventoryEntriesQueryResultFragment
- DefaultInventoryEntryFragment
- DefaultLineItemFragment
- DefaultOrderFragment
- DefaultReviewFragment
- DefaultStoreFragment
- DefaultStoreQueryResultFragment
- deleteBillingAddressDefaultQuery
- deleteBillingAddressMutation
- deleteCartDefaultQuery
- deleteCartMutation
- deleteReview
- deleteReviewDefaultQuery
- deleteShippingAddressDefaultQuery
- deleteShippingAddressMutation
- getBasicProfileQuery
- getCategory
- getCategoryDefaultQuery
- getChannelDefaultQuery
- getFacetCategoriesDefaultQuery
- getFacetProductProjectionDefaultQuery
- getFullProfileQuery
- getInventoryDefaultQuery
- getMeBasicProfileDefaultQuery
- getMeFullProfileDefaultQuery
- getMyOrdersQuery
- getMyShoppingListDefaultQuery
- getOrdersDefaultQuery
- getProduct
- getProductDefaultQuery
- getReview
- 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
- updateMyCustomer
- 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
- ApplyCartCouponParams
- Auth
- BaseSearch
- CartData
- CategoryWhereSearch
- ChannelsWhereSearch
- ClientInstance
- Config
- Context
- CookiesConfig
- CreateCartParams
- CreateMyOrderFromCartParams
- CreateMyShoppingListParams
- CustomerUpdateCurrentUser
- DeleteBillingAddressParams
- DeleteCartParams
- DeleteReviewParams
- DeleteShippingAddressParams
- FetchResult
- Filter
- FilterOption
- FlowOptions
- GetChannelParams
- GetFacetProductProjectionParams
- GetInventoryParams
- GetMeParams
- GetOrdersParams
- GetProductParams
- GetReviewParams
- GetShoppingListParams
- LineItemIdentifier
- LocaleItem
- OrderWhereSearch
- ProductIdentifier
- ProductWhereSearch
- RemoveCartCouponParams
- RemoveFromCartParams
- RemoveFromMyShoppingListParams
- ServerApiConfiguration
- SetDefaultBillingAddressParams
- SetDefaultShippingAddressParams
- SetupConfig
- SetupContext
- ShoppingListData
- ShoppingListWhereSearch
- Token
- UpdateBillingAddressParams
- UpdateCartItemChannelParams
- UpdateCartItemChannelProductParams
- UpdateCartParams
- UpdateCartQuantityParams
- UpdateCartQuantityProductParams
- UpdatedUserData
- UpdateMyCustomerParams
- UpdateShippingAddressParams
- UpdateShippingDetailsParams
Type Aliases
- AddBillingAddressResponse
- AddMultipleToMyShoppingListResponse
- AddReviewResponse
- AddShippingAddressResponse
- AddToCartResponse
- AddToMyShoppingListResponse
- ApiMethods
- ApiResponseWrapper
- ApplyCartCouponResponse
- BillingAddress
- BillingAddressAddParams
- BillingAddressDeleteParams
- BillingAddressResponse
- BillingAddressSetDefaultParams
- BillingAddressUpdateParams
- CartDetails
- CartMutationResponse
- CartQueryResponse
- CartResponse
- ChangeMyPasswordResponse
- ChannelSearchParams
- CommercetoolsIntegrationContext
- CreateCartResponse
- CreateMyOrderFromCartResponse
- CreateMyShoppingListResponse
- CreatePasswordResetTokenResponse
- CustomerChangeMyPasswordResponse
- CustomerCreatePasswordResetTokenResponse
- CustomerResetPasswordResponse
- CustomerSignMeInResponse
- CustomerSignMeUpResponse
- CustomerUpdateMeResponse
- CustomQuery
- DeleteBillingAddressResponse
- DeleteCartResponse
- DeleteReviewResponse
- DeleteShippingAddressResponse
- Endpoints
- GetCategoryResponse
- GetChannelResponse
- GetFacetCategoriesResponse
- GetFacetProductProjectionResponse
- GetInventoryResponse
- GetMeResponse
- GetMyShoppingListResponse
- GetOrdersResponse
- GetProductResponse
- GetReviewResponse
- GetShippingMethodsResponse
- GetShoppingListResponse
- 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
- UpdateCartItemChannelResponse
- UpdateCartQuantityResponse
- UpdateCartResponse
- UpdateMyCustomerResponse
- UpdateShippingAddressResponse
- UpdateShippingDetailsResponse
- User
- VSFLogger
- WishlistResponse