Skip to main content
GET
Get return shipment details
Retrieves the full record of a single return shipment — the shipment, its line items, its label, and any custom fields — by the returnRequestId returned from Create return shipment. A return shipment represents a parcel before warehouse receipt. Once the warehouse logs the parcel it becomes a return inventory item; from that point use Get return inventory details, which carries the post-receipt handling data.

Recovering a missed label

The label is at shipments[].label.labelUrl. The main use for this endpoint is reconciliation after a system incident: if your receiver missed a label notification, call it with the returnRequestId to read the current labelUrl and trackingNumber directly. An empty labelUrl means generation has not finished (or failed) — check shipments[].label.labelRequestStatusCode.
This is a backup path, not the primary one. Labels are generated asynchronously and delivered through the labelGenerated webhook, which is the source of truth. Don’t poll this endpoint to discover labels under normal operation — subscribe to Webhooks and use this endpoint only to backfill after a missed or failed delivery.

Authorizations

x-rr-apikey
string
header
required

Your API key

x-rr-apitoken
string
header
required

Your API token — keep this private

Query Parameters

returnRequestId
integer<int32>

Return request identifier, as returned by Create return shipment.

Response

Success

Full record of a return shipment. Successful responses also carry the standard envelope fields (correlationId, meta) alongside the fields below.

returnRequestId
integer<int32>

Return request identifier

returnRequestNumber
string

Return request number

sellerReferenceNumber
string

Your merchant-supplied reference, echoed back for reconciliation

returnStatusCode
string

Current return status code

returnTitle
string

Return title

totalValue
number

Declared total value of the return

totalValueCurrency
string

ISO 4217 currency code of totalValue (e.g. USD)

rma
string

Warehouse-assigned RMA reference (uppercased). Populated once the warehouse processes the parcel.

remarks
string

Free-text remarks

isArchived
boolean

Whether the return request is archived

returnRequestFrom
string

Origin/source of the return request

shipments
object[]

Shipments belonging to this return request, each with its label.

returnRequestLineItems
object[]

Line items included in the return request.

returnInventoryList
object[]

Return inventory records derived from this request, populated once the warehouse has received the parcel. Empty before receipt — use Get return inventory details for full inventory data at that stage.

returnShipmentCustomFieldList
object[]

Custom fields attached to the return shipment.