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 URL | https://{tenantId}-translation.mozu.com/api/v2/return/action/reopen/ |
| Sandbox URL | https://{tenantId}-translation.sandbox.mozu.com/api/v2/return/action/reopen/ |
| Supported Formats | JSON |
| HTTP Method | POST |
Example
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.
| Parameter | Type | Description |
| returnID | integer | A 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.