Home > @vsf-enterprise/sapcc

sapcc package

Enumerations

Enumeration Description
COOKIES_NAMES

Interfaces

Interface Description
AddAddressProps Structure of properties for AddAddress.
AddCartEmailProps Properties for assigning an email address to a cart.
AddCartEntryProps Properties for adding an entry to a cart.
AddCartVoucherProps Props for applying a voucher on a cart.
AddReviewParams Structure of properties for AddReview.
AddReviewProps Properties for adding a product review.
AddToWishlistProps Properties for adding an entry to the wishlist.
AddUserAddressProps Properties for adding user address.
ChangeUserPasswordProps Properties for updating an existing user password.
CloneCartProps Properties for cloning a cart.
Context $vsf Context.
CreateCartAddressProps Properties for creating an email address to a cart.
CreateCartPaymentDetailsProps Properties for creating and assigning a payment details object on a cart.
CustomQuery Contains keys that can be overwritten in query.
DeleteUserAddressProps Properties for deleting user address.
GetCartEntryProps Properties for getting a cart entry.
GetCookieProps Necessary props to find a cookie.
GetMaxProductQuantityProps Properties for getting maximum quantity that can be added to a cart for a given product.
GetOrderProps Structure of properties for GetOrder.
GiveConsentProps Properties for give consent.
LoadCartProps Properties for loading a cart.
LoadCategoryProps Properties for loading a single category.
LoadConfigProps Structure of properties for loadConfig.
LoadConsentsProps Properties for loading consents.
LoadCountriesProps Properties for loading countries.
LoadCountryRegionsProps Properties for loading country regions.
LoadOrderProps Properties for loading an existing order.
LoadPaymentDetailsListParams Properties for getting payment details list of user.
LoadProductSuggestionsProps Properties for loading product suggestions.
LoadReviewsProps Properties for loading product reviews.
LoadSopPaymentRequestProps Structure of properties for loadSopPaymentRequest.
LoadSopPaymentResponseProps Structure of properties for loadSopPaymentResponse.
LoadStoreProps Properties for loading a Base Store.
LoadUserAddressesProps Properties for loading user addresses.
LoadUserCartsProps Properties for loading user carts
LoadUserOrderHistoryProps Properties for loading user order history.
LoginUserProps Properties for signing an existing user in.
PlaceOrderProps Properties for making an order from an existing cart.
RegisterUserProps Properties for signing a new user up.
RemoveCartEntryProps Properties for removing an entry from a cart.
RemoveCartVoucherProps Props for removing a voucher on a cart.
RemoveConsentProps Properties for remove consent.
RemoveFromWishlistProps Properties for removing an entry from the wishlist.
RemovePaymentDetailsParams Properties for removing payment details of user.
ReplaceCartAddressProps Properties for replacing an email address in a cart.
ReplaceCartPaymentDetailsComposableProps Properties for replacing cart payment details
ReplaceCartPaymentDetailsProps Properties for replacing a payment details object on a cart.
SaveCartProps Properties for saving a cart.
SearchOrdersProps
SearchProductProps Properties for searching for a product.
SearchReviewParams Structure of properties for SearchReview.
SetCartDeliveryModesProps Properties for setting a delivery mode on a cart.
SetCookieProps Necessary props to add a new cookie.
SetDefaultUserAddressProps Properties for setting default user address.
SetOrderProps Properties for setting an order manually.
UpdateCartEntryProps Properties for updating an entry in a cart.
UpdatePaymentDetailsParams Properties for updating payment details of user.
UpdateUserAddressProps Properties for updating user address.
UpdateUserProps Properties for updating an existing user profile.
UseCartAddressesComposable Composable method allowing to manage cart addresses
UseCartAddressesError An indicator of useConsents composable methods errors
UseCartAddressesLoading An indicator of useCartAddressesLoading composable methods progress
UseCartComposable Composable method allowing to fetch and manage carts
UseCartDeliveryModesComposable Composable method allowing to fetch and set delivery modes for a cart
UseCartDeliveryModesError An indicator of UseCartDeliveryModes composable methods errors
UseCartDeliveryModesLoading An indicator of UseCartDeliveryModes composable methods progress
UseCartEntriesComposable Composable method allowing to manage cart entries
UseCartEntriesError An indicator of useCartEntries composable methods errors
UseCartEntriesLoading An indicator of useCartEntries composable methods progress
UseCartError An indicator of useCart composable methods errors
UseCartLoading An indicator of useCart composable methods progress
UseCartPaymentDetailsComposable Composable method for managing payment details on a cart
UseCartPaymentDetailsError An indicator of UseCartPaymentDetails composable methods errors
UseCartPaymentDetailsLoading An indicator of useCartPaymentDetails composable methods progress
UseCartPromotionsComposable Composable method for managing cart promotions
UseCartPromotionsError An indicator of useCartPromotions composable methods errors
UseCartPromotionsLoading An indicator of useCartPromotions composable methods progress
UseCategoryComposable Composable method for loading and storing categories.
UseCategoryError An indicator of useCategory composable methods errors
UseConsentsComposable Composable method allowing to fetch & manage consents
UseConsentsError An indicator of useConsents composable methods errors
UseConsentsLoading An indicator of useConsents composable methods progress
UseCountriesComposable Composable method allowing to load countries.
UseCountriesError An indicator of useCountries composable methods errors.
UseCountriesLoading An indicator of useCountries composable methods progress.
UseCountryRegionsComposable Composable method allowing to load country regions.
UseCountryRegionsError An indicator of useCountryRegions composable methods errors.
UseCountryRegionsLoading An indicator of useCountryRegions composable methods progress.
UseMiscsComposable Composable method allowing to load miscellaneous data such as card types, currencies, languages and titles.
UseMiscsError An indicator of useMiscs composable methods errors.
UseMiscsLoading An indicator of useMiscs composable methods progress.
UseOrderComposable Composable method allowing to fetch and place orders.
UseOrderError An indicator of useOrder composable methods errors
UseOrderLoading An indicator of useOrder composable methods progress
UseProductComposable Composable method allowing to search for and store products.
UseProductError An indicator of useProduct composable methods errors.
UseProductFactoryProps Contains all required params for useProductFactory function.
UseProductLoading An indicator of useProduct composable methods progress.
UseProductReferencesComposable Composable method allowing to fetch product references
UseProductReferencesErrors An indicator of useProductReferences composable methods errors
UseProductSearchComposable Composable method for performing product searches and storing results.
UseProductSearchError An indicator of useProductSearch composable methods errors
UseProductSuggestionsComposable Composable method for loading and storing product suggestions.
UseProductSuggestionsError An indicator of useProductSuggestions composable methods errors
UseReviewComposable Composable method allowing to fetch and add product reviews.
UseReviewError An indicator of useReview composable methods errors.
UseReviewLoading An indicator of useReview composable methods progress.
UseStoreComposable Composable method allowing to fetch and manage Stores
UseStoreError An indicator of useStore composable methods errors
useUserAddressesComposable Composable method allowing to fetch & user addresses
UseUserAddressesError An indicator of useConsents composable methods errors
UseUserAddressesLoading An indicator of useConsents composable methods progress
UseUserCartsComposable Composable method allowing to fetch and store user carts
UseUserCartsError An indicator of useUserCarts composable methods errors
UseUserCartsLoading An indicator of useUserCarts composable methods progress
UseUserComposable Composable method for loading, authenticating and registering a user.
UseUserError An indicator of useUser composable methods errors.
UseUserOrderHistoryComposable Composable method allowing to load user orders.
UseUserOrderHistoryError An indicator of useUserOrderHistory composable methods errors.
UseUserOrderHistoryLoading An indicator of useUserOrderHistory composable methods progress.

Variables

Variable Description
ANONYMOUS_USER_ID
AUTH_USER_TOKEN_COOKIE_NAME
AUTH_USER_TOKEN_SET_COOKIE_NAME
CART_ID_COOKIE_NAME
cartGetters Returns agnostic cart values.
categoryGetters
CURRENT_USER_ID
facetGetters
injectContext
orderGetters
productGetters Returns agnostic product values.
reviewGetters
searchGetters Returns agnostic search values.
useCart
useCartAddresses
useCartDeliveryModes
useCartEntries
useCartPaymentDetails
useCartPromotions
useCategory
useConsents
useCountries
useCountryRegions
useMiscs
useMockedPSP
useOrder
usePayment
useProduct
useProductReferences
useProductSearch
useProductSuggestions
USER_COOKIE_NAME
userBillingGetters
useReview
userGetters
userShippingGetters
useStore
useUser
useUserAddresses
useUserCarts
useUserOrderHistory

Type Aliases

Type Alias Description
Category
Coupon
LoadAllCategoriesProps Properties for loading all categories defined for a catalog version.
LoadUserProps Properties for loading a user.
Order
OrderItem
ProductsResponse
SapccIntegrationContext
Shipping
ShippingMethod
User
UserAddress
UserContext