@abra-promotions/webhooks-for-tapcart
v1.0.1
Published
Abra webhooks for enabling abra promotions inside the Tapcart platform
Downloads
16
Readme
@abra/tapcart-webhooks
Abra Tapcart webhook integrations for promotions, cart management, and activation.
Installation
npm install @abra/tapcart-webhooksUsage
useTapcart, and tapcartData are properties provided by tapcart for every block.
useAbra
Main hook for Abra promotion logic, use it within tapcart to parse any product into it's discounted version.
import { useAbra } from "@abra/tapcart-webhooks";
const MyComponent = ({ useTapcart, tapcartData }) => {
//Initialize
const { abra } = useAbra({ useTapcart, tapcartData });
// Use for promotion logic
const productWithDiscountedPrice = abra.getProductWithDiscount(product);
return <div>...</div>;
};useAbraActivate
Hook for activation logic, add it to the homepage, will enable and disable promotions
import { useAbraActivate } from "@abra/tapcart-webhooks";
const MyComponent = ({ useTapcart, tapcartData }) => {
useAbraActivate({
useTapcart,
tapcartData,
discountCode, // (Optional) used for activating private promotions
displayToast, // (Optional) whether will show a banner after a promotion is activated
redirectPath, // (Optional) Wheather it should redirect to a specific page after activating
testDeviceId, // (Optional) Allows activating test promotion code on this device
testPromotionCode, // (Optional) Code that will activate on test device
autoApplyDiscount, // (Optional) Make it false for automatic discounts
});
return <div>...</div>;
};useAbraCart / AbraCartBlock
Cart-specific functionality: control discounts, attributes and gift items. load it in the cart page.
import { useAbraCart } from "@abra/tapcart-webhooks";
const CartComponent = ({ useTapcart, tapcartData }) => {
useAbraCart({ useTapcart, tapcartData });
return <div>...</div>;
};Requirements
- React 16.8+
- @tapcart/mobile-components ^0.7.25
License
MIT
