Skip to main content
GET
/
api
/
ReturnInventory
/
GetReturnInventory
Get return inventory details
curl --request GET \
  --url https://api.returnshelper.com/uat/user/api/ReturnInventory/GetReturnInventory \
  --header 'x-rr-apikey: <api-key>' \
  --header 'x-rr-apitoken: <api-key>'
{
  "returnInventoryId": 123
}
Fetches the full record of a single return inventory item by its returnInventoryId.

​
Inventory photos

The response includes a returnRequestLineItemImages[] array of photos attached to the inventory’s line item. The endpoint returns S3 keys, not URLs — to display or fetch a photo, build a URL by concatenating the environment-specific hostname with the key.

​
Entry shape

Each entry exposes four resized variants of the same photo, so you can pick the right one for your UI:
FieldTypical use
s3SmallFileKeyThumbnails in list views
s3MediumFileKeyPreview in detail views
s3LargeFileKeyFull-screen preview
s3OriginalFileKeyOriginal upload (largest; only when you need the unscaled image)

​
URL construction

Hostname per environment:
EnvironmentPhoto hostname
Sandbox (UAT)rr-dev-files.returnshelper.com
Productionfile.returnhelpercentre.com
Formula: 
URL = "https://" + <photo hostname> + "/" + <key>
Production example: 
s3MediumFileKey = "img/returns/202606/27_1000040536_lmpiohbx.5n3_medium.jpg"
                  ↓ concatenate
URL             = "https://file.returnhelpercentre.com/img/returns/202606/27_1000040536_lmpiohbx.5n3_medium.jpg"
The key already contains the full S3 path. Constructed URLs are publicly fetchable, require no authentication header, and do not expire. URLs and content are safe to cache client-side.
Treat the path as opaque. Return Helper has historically used multiple path prefixes (e.g. img/returns/... and images/returns/...); only the hostname is guaranteed stable. Never parse, validate, or pattern-match the path or filename.
Empty state: returnRequestLineItemImages: [] when no photos are attached.
This endpoint reflects the current state at query time. For real-time notifications when warehouse staff add, replace, or remove photos, subscribe to the changeLineItemImage webhook rather than polling.

Authorizations

​
x-rr-apikey
string
header
required

Your API key

​
x-rr-apitoken
string
header
required

Your API token — keep this private

Query Parameters

​
returnInventoryId
integer<int64>

Return inventory identifier

Response

Success

​
returnInventoryId
integer<int64>

Return inventory identifier