Skip to main content
POST
/
admin
/
returns
/
{id}
/
cancel
JS SDK
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.cancel("return_123")
.then(({ return }) => {
  console.log(return)
})
{
  "return": {
    "id": "<string>",
    "order_id": "<string>",
    "items": [
      {
        "id": "<string>",
        "quantity": 123,
        "received_quantity": 123,
        "damaged_quantity": 123,
        "item_id": "<string>",
        "return_id": "<string>",
        "reason_id": "<string>",
        "note": "<string>",
        "metadata": {}
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "canceled_at": "2023-11-07T05:31:56Z",
    "order_version": 123,
    "display_id": 123,
    "received_at": "<string>",
    "status": "canceled",
    "refund_amount": 123,
    "exchange_id": "<string>",
    "location_id": "<string>",
    "claim_id": "<string>",
    "no_notification": true
  }
}

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.

Body

application/json

The details of canceling a return.

​
no_notification
boolean

Whether to send the customer a notification about the return's cancelation.

Response

OK

The return's details.

​
return
object
required

The return's details.