Get Returnable Items


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.

The Get Returnable Items API provides a merchant with the list of all items that can be returned on an particular order.

The data returned by this request is 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}{orderID}
Sandbox URLhttps://{tenantId}{orderID}
Supported FormatsJSON


The Get Returnable Items API call requires an Order ID, as it analyzes the items within that single order and returns the ones that are able to be returned. This example has the following properties:

  • Returnable Items: Two Shirts
  • No Restocking Fee

General Information

The response from the API is fairly straightforward. It will repeat the Order ID and provide a new Returnable Shipment object that includes the following information:

  • Shipment ID
  • Restocking Fee
  • Item Details

The Full Request

Using the URL format as outlined above, the entire call is simple to put together. 


The Full Response

This is the complete response returned by the API. This particular example only has a single returnable item, but shipments with multiple would list each item.

    "orderID": 0000000,
    "returnableShipment": [
            "shipmentID": 1234567,
            "restockingFee": false,
            "item": [
                    "orderItemID": 7654321,
                    "quantity": 2,
                    "returnSubtotal": 35.19,
                    "fulfillerSubtotal": 35.19,
                    "partNumber": "1234567",
                    "partName": "Shirt",
                    "returnRestriction": "RETURNABLE",
                    "options": [
                        "Gender: Men",
                        "Brand: TestShirts",
                        "Size: S",
                        "Color: White",
                        "Manufacturer Part #: 10101"