loyaltyengage/loyaltyshop

Magento 2 module to add products to cart based on loyalty points

Maintainers

Details

github.com/Loyalty-Engage/LoyaltyEngageMagento

Homepage

Source

Issues

Installs: 8

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 2

Forks: 0

Open Issues: 0

Type:magento2-module

dev-master 2025-05-05 16:36 UTC

Requires

  • php: ^7.4 || ^8.1 || ^8.2
  • magento/framework: ^103

MIT 14654960373080c294f8b566e3de862072cfbd75

  • LoyaltyEngage Team <info.woop@loyaltyengage.com>

ecommercecartloyaltypointsmagento2

This package is not auto-updated.

Last update: 2025-05-05 16:41:10 UTC

README

A Magento 2 module that allows customers to add products to their cart based on loyalty points.

Features

  • Add products to cart based on loyalty points
  • Automatic cart expiry for loyalty-based items
  • Order processing for loyalty-based purchases
  • Admin configuration for loyalty program settings
  • Integration with Magento's customer and cart systems

Requirements

  • PHP 7.4 or higher
  • Magento 2.4.x or higher
  • Composer

Installation

Via Composer (Recommended)

  1. Add the repository to your Magento 2 project's composer.json:
composer require loyaltyengage/loyaltyshop
  1. Enable the module:
bin/magento module:enable LoyaltyEngage_LoyaltyShop
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:flush

Manual Installation

  1. Create a directory structure in your Magento installation: app/code/LoyaltyEngage/LoyaltyShop
  2. Download the module and extract its contents to the directory you created
  3. Enable the module:
bin/magento module:enable LoyaltyEngage_LoyaltyShop
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento setup:static-content:deploy -f
bin/magento cache:flush

Configuration

  1. Log in to your Magento Admin Panel
  2. Navigate to Stores > Configuration > LoyaltyEngage > LoyaltyShop
  3. Configure the following settings:
    • API Connection Settings
    • Cart Expiry Options
    • Order Processing Settings

Usage

Frontend

The module adds functionality to the customer's shopping cart, allowing them to:

  • Add loyalty-based products to their cart
  • View loyalty points balance
  • Process orders using loyalty points

API Endpoints

The module provides the following API endpoints:

  • POST /V1/loyaltyengage/cart: Add loyalty-based products to cart
  • DELETE /V1/loyaltyengage/cart/items/{itemId}: Remove a specific loyalty item from cart
  • DELETE /V1/loyaltyengage/cart/items: Remove all loyalty items from cart

Cron Jobs

The module includes the following cron jobs:

  • loyaltyengage_cart_expiry: Removes expired loyalty items from carts
  • loyaltyengage_order_place: Processes loyalty-based orders

Support

For support, please contact:

License

This module is licensed under the MIT License - see the LICENSE file for details.