GET
/
admin
/
returns
/
{id}
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.return.retrieve("return_123")
.then(({ return }) => {
  console.log(return)
})
{
"return": {
"id": "<string>",
"status": "canceled",
"refund_amount": 123,
"order_id": "<string>",
"items": [
{
"id": "<string>",
"quantity": 123,
"received_quantity": 123,
"damaged_quantity": 123,
"reason_id": "<string>",
"note": "<string>",
"item_id": "<string>",
"return_id": "<string>",
"metadata": {}
}
],
"created_at": "2023-11-07T05:31:56Z",
"canceled_at": "2023-11-07T05:31:56Z",
"exchange_id": "<string>",
"location_id": "<string>",
"claim_id": "<string>",
"order_version": 123,
"display_id": 123,
"no_notification": true,
"received_at": "<string>"
}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The return's ID.

Query Parameters

fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Response

200
application/json

OK

The return's details.