Platform Integration Guide
Welcome to Compare and Recycle's Platform Integration Guide. Our versatile platform ensures a smooth onboarding and operation experience for all our partners across different regions. This guide will walk you through the key components of our integration process and platform features.
Platform Overview
Our Platform is a centralized system designed to streamline your operations and provide real-time insights into your recycling business. While some features may vary by region, the core functionality remains consistent.
Key Components
- Webhook Integration
- Product Management
- Order Management (Optional)
- Reporting and Analytics
1. Webhook Integration
We use a generic webhook system to send real-time notifications to your systems. Key points about our webhook system:
- Webhooks are sent as JSON payloads via POST requests
- Supports various event types, including order creation
- Includes comprehensive order and device details
- Implements retry mechanism for failed deliveries
For detailed information on our webhook system, including payload format and best practices, please refer to our Webhook Documentation.
2. Product Management
You have two options for managing your products on our platform:
a) Direct Management: You can manually add, update, and manage your products directly within the Platform interface.
b) Scheduled Import Feed: For partners with large or frequently changing inventories, we offer a scheduled import feed system. This allows you to automatically update your product catalog at regular intervals.
Feeds can be in various formats, including CSV, XML, or JSON. Our team will work with you to determine the best approach based on your needs.
3. Order Management (Optional)
While integrating with our webhook system is required, using the order management features of the Platform is optional. If you choose to use it, you can:
- View and manage incoming orders
- Update order statuses
- Generate order exports
Note: Postage integrations are currently only supported in the UK.
Regional Variations
While most features are available globally, some aspects of the platform may vary by region. We'll clearly communicate any region-specific features or limitations during your onboarding process.
Support
We're committed to ensuring a smooth integration process. If you encounter any issues or have questions, please don't hesitate to reach out:
Next Steps
- Review our Webhook Documentation
- Set up your Platform access (contact our team for credentials)
- Choose your preferred product management method
- Implement the webhook endpoint in your system
- Conduct thorough testing using the provided test email addresses
- Explore additional platform features as needed
We're excited to have you on board and look forward to a successful partnership!