Maxxing Documentation
Maxxing is a comprehensive loyalty marketing and promotion platform that enables retailers to create, manage, and deploy promotional offers, loyalty programs, and customer engagement campaigns across all sales channels.
🚀 Getting Started
| Guide | Description |
|---|---|
| Promotion Overview | Learn how to create and manage promotional offers |
| Loyalty Overview | Understand accounts, customers, and cards |
| POS Integration | Integrate Maxxing with your point of sale systems |
📚 Documentation Sections
👤 User Guide (1-userguide/)
Functional documentation for business users and loyalty managers.
- Promotion — Offers, criteria, actions, item lists, priority management
- Loyalty — Accounts, customers, cards, profiles, merge process
- Counter — Point counters and accumulators
- Coupon — Coupons, promo codes, CSS customization
- Targeting — Customer targeting and segmentation
🔧 Technical Reference (2-technical/)
Developer documentation for system integrators and IT administrators.
- Administration — API keys, users, identity providers, custom functions
- POS Integration — Store server workflows, transaction protocols
- Customer API — Account search, customer data, merge operations
- Coupon Configuration — Voucher setup, coupon technical details
- Webhooks — Event notifications and integrations
🔗 API Reference (api/)
OpenAPI specifications for all Maxxing services.
- Authentication — OAuth and API key authentication
- Store Server — Transaction processing endpoints
- Customer — Customer and account management
- Voucher — Coupon and voucher operations
- Bulk Operations — Mass data import/export
📖 Advanced Topics (3-advanced/)
- Application Limits — Platform constraints and quotas
- Error Codes — API error reference
- GDPR — Data privacy compliance
📖 Glossary
- Glossary — Complete glossary of all business and technical terms used in Maxxing
🔍 Search Tips
- Use the sidebar to navigate through documentation sections
- Use Ctrl+K (or Cmd+K on Mac) to open the search dialog
- Search for specific terms like
storeValidTransaction,counter, orvoucher
📞 Support
For technical support or questions about Maxxing:
- Contact your Maxxing account manager
- Refer to the Error Codes guide for troubleshooting
- Check Application Limits for platform constraints
📋 Changelog
For the latest updates and release notes, contact your Maxxing representative or check the platform release documentation.