Documentation Migration - December 2024
Release Date: December 15, 2024 Type: 🟢 Enhancement Products: All
Overview
Complete API documentation overhaul with enhanced guides across all products. We've migrated to a modern MDX-based documentation format with interactive code examples and improved navigation.
This update represents a comprehensive refresh of our developer portal, making it easier for integration partners to find information, understand our APIs, and build successful integrations.
API Updates
POS API
New Endpoints Documented:
- Tickets - Comprehensive documentation for lookup and retrieve methods
- Customers - Customer management and retrieval
- Employees - Employee data access and management
- Jobs - Job tracking and management
- Taxes - Tax configuration and calculation
- Tenders - Payment tender information
- Revenue Classes - Revenue classification for reporting
- Time Cards - Employee time tracking
- Cash Drawer Transactions - Cash drawer management and reconciliation
Webhooks:
- Batch Ticket Updated - Real-time POS data sync webhook for batch ticket updates
Online Ordering API
V3 Enhancements:
- Enhanced delivery integration for third-party delivery services
- Menu stock status updates for real-time inventory management
- Improved order status management
- Additional webhook events for comprehensive order lifecycle tracking
V2 Updates:
- Comprehensive order workflow documentation
- FAQ section addressing common integration questions
- Improved error handling examples
Marketplace API
New Features:
- Multiple OAuth flow options:
- Link Token flow
- Installation Request flow
- Lighthouse Token flow
- Enhanced location management
- Improved webhook notifications for installation lifecycle
- Better error handling and retry logic
Mobile Payments API
New Documentation:
- Mobile check retrieval and payment processing
- Complete API reference for mobile payment integration
- Step-by-step integration guides
- Best practices for mobile payment flows
Documentation Improvements
Format & Structure
- Modern MDX Format - Component-based documentation with better interactivity
- Interactive Code Examples - Copy/paste ready examples in multiple languages
- Visual Flow Diagrams - Clear visualization of complex processes
- Improved Table of Contents - Better navigation with in-page sections
- Mobile Responsive - Optimized for mobile and tablet viewing
Navigation & Search
- Improved Navigation - Clearer product categorization
- Better Search - Enhanced search functionality
- Breadcrumbs - Easy navigation back through documentation hierarchy
- Quick Links - Jump to common topics faster
Code Examples
- Multiple programming languages supported
- Real-world integration examples
- Error handling patterns
- Authentication examples
Coming Soon
We're continuously improving our APIs and documentation. Stay tuned for:
- Additional webhook events across all platforms
- Enhanced filtering and query capabilities
- More code examples in additional programming languages
- Video tutorials and integration guides
- Interactive API playground
- Email notifications for API changes (Phase 2)
- RSS feed for changelog updates (Phase 2)
Feedback
We value your feedback! If you have suggestions for improvements or find issues in our documentation:
- Report Issues: Contact Shift4 Support
- Developer Community: Join our developer community for discussions and updates
Stay Connected
- API Status: Check status.shift4.com for real-time API status
- Changelog: Visit /changelog regularly for the latest updates
- Documentation Updates: All changes are tracked in our changelog