API Reference

Partner API Guide

Guide to integrating with ReturnBear's Partner API

Introduction

The Partner API enables seamless integration with ReturnBear's reverse logistics services. This RESTful API allows you to leverage ReturnBear's logistics infrastructure while maintaining control over your RMA (Return Merchandise Authorization) process.

Getting Started

To begin using the API:

  1. Contact us at [email protected] to create an account
  2. We'll provide you with an API key for authentication
  3. Use the API key in the Authorization header for all requests. This is meant to be used as a Bearer token.

Integration Flow

Here's how the typical return flow works:

API Endpoints

1. Create Return Case

This is your entry point for initiating a return and providing ReturnBear with the necessary information needed to physically accept returning items from consumers. The endpoint creates a return case in ReturnBear's platform, enabling the ability to manage the reverse logistics process.

View Create Return Case Documentation →

2. List Return Methods

After creating a return case, use this endpoint to retrieve available return methods. ReturnBear analyzes the return details to determine the most appropriate options:

  • Return Point Drop-off: Provides a list of nearby authorized drop-off locations based on item characteristics and additional services like verified returns for instant payout at return drop-off.
  • Courier Pickup: ReturnBear selects the optimal courier based on location and item characteristics.

View Return Methods Documentation →

3. Select Return Method

Once you've chosen a return method from the available options, confirm your selection using this endpoint.

View Select Return Method Documentation →

4. Get Return Case Details

Use this endpoint to retrieve the current status and details of any return case. This is particularly useful for tracking the progress of returns and updating your systems accordingly. For real-time updates, please refer to the webhook guide.

View Get Return Case Documentation →

Best Practices

  • Store the return case ID after creation for future reference
  • Implement webhook listeners to receive real-time updates about return status changes
  • Use the Get Return Case endpoint sparingly - implement webhooks for status updates instead