Reopen Return


This documentation is for translated APIs and intended only for some implementations who have upgraded from a previous version of Order Management. Verify whether your implementation uses translated APIs before making this call, as you will experience errors if your tenant is not configured to use these. If your implementation is not configured to do so, then refer to the standard API documentation instead.

In the event that a merchant or fulfiller needs a closed case to be reopened, such as if it were marked closed by mistake, that can be done with the reopen action of the Return API.

Note that the request body and parameter schemas outlined in this guide are the exact same as in the previous version of OMS, as the Unified Commerce platform supports backwards compatibility for this API. The only change to this request is the format of the base endpoint, as shown in the below table. Remember to provide the x-vol-tenant key for authentication in the headers.

Production URLhttps://{tenantId}
Sandbox URLhttps://{tenantId}
Supported FormatsJSON


This example will reopen a return with the ID 00000.

Required Parameters

The only required parameter is the Return ID, and there are no optional properties.

returnIDintegerA unique identifier for the return. The minimum value is “1”.

The Full Request

This is all that a call would look like. Note that the Return ID is included in the body of the request and not in the URL.

 "returnID" : 00000

The returned response follows the same structure as the Get Return API, providing information about the return that was reopened.