Overview
Scanner API
Admin API
- GETList Returns
- POSTCreate Return
- GETGet a Return
- POSTUpdate a Return
- POSTCancel a return.
- POSTAdd Damaged Items to Return
- POSTUpdate Damaged Item of Return
- DELRemove Damaged Item from Return
- POSTStart Return Receival
- DELCancel Return Receival
- POSTAdd Received Items to Return
- POSTUpdate a Received Item in a Return
- DELRemove a Received Item from Return
- POSTConfirm Return Receival
- POSTConfirm Return Request
- DELCancel Return Request
- POSTAdd Requested Items to Return
- POSTUpdate Requested Item in Return
- DELRemove Item from Return
- POSTAdd a Shipping Method to a Return
- POSTUpdate a Shipping Method of a Return
- DELRemove Shipping Method from Return
- GET
JS SDK
Copy
import Switchyard from "@switchyard/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.cancelRequest("return_123")
.then(({ return }) => {
console.log(return)
})Copy
{
"id": "<string>",
"object": "return",
"deleted": true
}Returns
Cancel Return Request
Cancel a requested return.
DELETE
/
admin
/
returns
/
{id}
/
request
JS SDK
Copy
import Switchyard from "@switchyard/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.cancelRequest("return_123")
.then(({ return }) => {
console.log(return)
})Copy
{
"id": "<string>",
"object": "return",
"deleted": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The return's ID.
⌘I