Skip to main content

​
What Are Custom Site Integrations?

Custom site integrations enable businesses with proprietary or custom-built ecommerce platforms to connect with Redo’s return management system through our comprehensive REST API. Whether you’ve built your storefront from scratch, use a headless commerce architecture, or have unique business requirements that standard integrations don’t address, Redo’s API provides the flexibility to create a tailored integration. Primary Purpose: Custom integrations give developers complete control over how Redo connects with your ecommerce platform, enabling sophisticated workflows, custom business logic, and seamless integration with your existing technology stack.

​
What Does the Integration Do?

A custom integration uses Redo’s REST API to sync order data, create returns, process refunds, and manage the entire return lifecycle programmatically. Your development team builds the integration to meet your specific needs, determining which data to sync, when to sync it, and how returns should be processed within your unique business workflows. Through the API, you can push order and product data to Redo, retrieve return requests initiated by customers, update return statuses, generate shipping labels, process refunds, and receive webhook notifications for return events. The integration can be as simple or sophisticated as your requirements demand, from basic order syncing to complex multi-warehouse, multi-currency operations.

​
How to Set It Up

Follow these steps to build a custom integration with Redo.

​
Prerequisites

Before you begin, ensure you have:
You need a development team familiar with REST APIs and your ecommerce platform’s architecture.
You need API credentials from your Redo merchant dashboard with appropriate scopes.
You need administrative access to your Redo merchant dashboard to generate API keys and configure settings.
Review Redo’s API documentation at docs.getredo.com/api-reference to understand available endpoints and data structures.

​
Configuration Steps

1

Generate API Credentials

Go to Settings > API in your Redo dashboard and generate API credentials with the appropriate scopes for your integration needs.
2

Review API Documentation

Study the API Reference to understand authentication, available endpoints, request/response formats, and webhook events.
3

Build the Integration

Develop your custom integration using your preferred programming language and framework. Implement order syncing, return creation, and any additional features you need.
4

Implement Webhooks

Set up webhook endpoints in your system to receive real-time notifications about return status changes, refund processing, and other events.
5

Test Thoroughly

Test your integration in Redo’s sandbox environment before going live. Verify order syncing, return creation, refund processing, and error handling.
6

Deploy to Production

Once testing is complete, deploy your integration to production and monitor for any issues.

​
How Long Does It Take?

​
Setup Timeline

The timeline for a custom integration varies significantly based on complexity, features, and your development team’s familiarity with Redo’s API.
Complexity LevelTime EstimateDescription
Simple1-2 weeksBasic order sync and return creation
Moderate2-4 weeksFull return lifecycle, webhooks, refund handling
Complex4-8 weeksMulti-currency, multi-warehouse, custom workflows
Enterprise8+ weeksAdvanced features, multiple integrations, custom UI

​
Development Considerations

1

API Authentication

Implement secure authentication using API keys and follow best practices for credential management.
2

Data Synchronization

Decide on sync strategy (real-time vs. batch) and implement error handling for failed syncs.
3

Webhook Processing

Build reliable webhook handlers that can process events, handle retries, and prevent duplicate processing.
4

Error Handling

Implement comprehensive error handling, logging, and monitoring to quickly identify and resolve issues.
5

Testing

Create thorough test cases covering normal operations, edge cases, and error scenarios.

​
Need Help?

Building a custom integration requires technical expertise. Redo’s developer documentation provides comprehensive guides, code examples, and API references to support your development team.

API Reference

Complete API documentation with endpoints and examples

Authentication

Learn how to authenticate API requests

Webhooks

Set up webhooks for real-time event notifications

Custom Integration Guide

Step-by-step guide for building custom integrations

​
Support

For issues with the Redo integration configuration, return processing, or data synchronization, contact support@getredo.com. For issues with access, API credentials, or warehouse operations, contact your account manager or support team.