> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Webshipper

> Connect Webshipper to Redo to create a Webshipper return for each approved return and process it when your warehouse marks it received

## What is Webshipper?

Webshipper is a shipping and returns platform. Each Webshipper return belongs to a return portal in your Webshipper account. Redo's Webshipper integration creates a return in Webshipper when a return is approved in Redo, and can process the return in Redo once Webshipper marks it received.

## What the integration does

When a return is approved in Redo, the integration creates a return in Webshipper against the original order. Redo creates one Webshipper return for each return label that ships to a return address set to Webshipper. Each Webshipper return has:

* **The return items only**, matched to the Webshipper order lines. Items the customer keeps (green returns) are left off.
* **The return portal** you set in Redo.
* **The return reason** as text on each item, plus the **Return cause ID** if you set one.

Redo finds the Webshipper order by its external reference (`ext_ref`) matching the Shopify order ID, then by its visible reference (`visible_ref`) matching the Shopify order name with and without `#`. Redo ignores cancelled Webshipper orders. Order lines match by `ext_ref` against the Shopify line item ID, then by SKU.

### Two-way sync

With **Two-way sync** on, Redo processes the return when the Webshipper return reaches the status you choose:

| Setting | Redo processes the items when Webshipper shows |
| - | - |
| **Processed** (default) | `processed` |
| **Arrived** | `arrived` or `processed` |

* Redo processes the items without restocking them. Webshipper is the system of record for inventory.
* If Webshipper sets the status `error`, Redo flags the return and shows Webshipper's error message on the return timeline.
* If a linked Webshipper return is deleted in Webshipper, Redo flags the return. Redo does not flag a return it deleted itself.

With **Two-way sync** off, Redo only creates returns in Webshipper.

### Other return changes

* **Return reset or rejected in Redo**: Redo deletes the Webshipper return, unless Webshipper shows it as `arrived` or `processed`. In that case Redo keeps the return and adds a note on the timeline to handle it in Webshipper.
* **Failed delete**: Redo keeps the link and adds a note on the timeline.

## How to set it up

### Prerequisites

> [accordion] Webshipper account
>
> You need a Webshipper account and permission to create an API token.

> [accordion] Orders flow through Webshipper
>
> Your Shopify orders must exist in Webshipper, so Redo can find the original order and its order lines.

> [accordion] Return portal
>
> Every Webshipper return belongs to a return portal. Have the ID of the portal you use for Redo returns.

### Configuration steps

**1. Route returns to Webshipper**

Redo creates a Webshipper return only for labels that ship to a return address whose **External return hub → Provider** is **Webshipper**. Set it on the return address you use for Webshipper returns.

**2. Create an API token**

In Webshipper, go to **Settings → Access and tokens** and create a token.

**3. Open the integration**

In Redo, go to **Settings → Integrations** and open **Webshipper**.

**4. Connect Webshipper**

On the **Returns** row, click **Connect** and fill in:

* **Account name**: the part before `.webshipper.io` in your Webshipper address
* **API token**: the token you created
* **Return portal ID**: the ID of the portal for Redo returns
* **Return cause ID** (optional): the Webshipper return cause sent on each item. The customer's return reason is always sent as text.

**5. Choose what Redo does**

* **Create returns**: create a return in Webshipper when a return is approved in Redo. On by default.
* **Two-way sync**: process the return in Redo when Webshipper reaches the status in **Process when the return is**. On by default, and available only when **Create returns** is on.

**6. Connect and save**

Click **Connect**. Redo reads your return portal to check the account name, API token, and portal ID. To change a setting later, click **Manage**, then **Save**. To replace the token, click **Replace**. Redo checks access again when you change the account name, token, or portal ID. You cannot change the account name while open returns are linked to Webshipper returns; close or reset them first.

**7. Test the integration**

1. Approve a return in Redo for an order that is in Webshipper
2. In Webshipper, open the return in your return portal and check the items
3. In Webshipper, mark the return `processed` (or `arrived`, if you chose **Arrived**)
4. Check that Redo processes the return

## Disconnecting

To disconnect, click **Disconnect** on the **Returns** row. Redo stops creating returns in your Webshipper account and removes its webhooks. Returns already created in Webshipper stay there and are no longer synced.

## Troubleshooting

Failures to create a return show on the return in Redo with one of these messages.

> [accordion] Webshipper rejected the account name or API token
>
> **Solution:**
>
> * Check the **Account name** and **API token** in the Webshipper settings in Redo, then retry from the actions menu on the return

> [accordion] Webshipper could not find this order or one of its order lines
>
> **Solution:**
>
> * Confirm the order exists in Webshipper
> * Check that the order lines carry the Shopify line item ID or a unique SKU
> * Retry from the actions menu, or create the return in Webshipper by hand

> [accordion] Webshipper rejected the return details
>
> **Solution:**
>
> * Check the **Return portal ID** and **Return cause ID** in the Webshipper settings in Redo
> * Check the returned products against the Webshipper order, then retry

> [accordion] The Webshipper API returned an error
>
> **Solution:**
>
> * Retry from the actions menu, or create the return in Webshipper by hand

## FAQ

> [accordion] Which returns does Redo create in Webshipper?
>
> Redo creates a Webshipper return for approved returns on orders that exist in Webshipper. Cancelled returns, green-only returns, in-store and POS returns, recycle returns, returns on third-party orders and returns without an order are not sent. If no order or order line matches, Redo does not create a return.

> [accordion] Does Redo process partial receipts?
>
> Webshipper return lines carry no received quantity, so Redo treats the status you choose as full receipt of every unprocessed item on that label.

> [accordion] Can one Webshipper return cover several orders?
>
> Redo creates one Webshipper return per order, and uses an order match only when one order holds every returned item. A Redo return that includes items from more than one order gets an error. Create those returns in Webshipper by hand, one per order, then dismiss the error.

## Support

For issues with the Redo integration configuration, return processing, or data synchronization, contact **[support@getredo.com](mailto:support@getredo.com)**.

For issues with Webshipper access, API credentials, or warehouse operations, contact your Webshipper account manager or support team.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.