Overview
Scanner API
Admin API
- GETList Exchanges
- POSTCreate Exchange
- GETGet an Exchange
- POSTCancel an Exchange
- POSTAdd Inbound Items to an Exchange
- POSTUpdate an Inbount Item of an Exchange
- DELRemove Inbound Item from Exchange
- POSTAdd an Inbound Shipping Method to an Exchange
- POSTUpdate Inbound Shipping Method of an Exchange
- DELRemove Inbound Shipping Method from Exchange
- POSTAdd Outbound Items to Exchange
- POSTUpdate Outbound Item of an Exchange
- DELRemove Outbound Item from Exchange
- POSTAdd Outbound Shipping Method to Exchange
- POSTUpdate Outbound Shipping Method of Exchange
- DELRemove Outbound Shipping Method from Exchange
- POSTConfirm an Exchange
- DELCancel Exchange Request
- 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.exchange.cancel("exchange_123")
.then(({ deleted }) => {
console.log(deleted)
})Copy
{
"id": "<string>",
"object": "exchange",
"deleted": true
}Exchanges
Cancel Exchange Request
Cancel a requested exchange.
DELETE
/
admin
/
exchanges
/
{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.exchange.cancel("exchange_123")
.then(({ deleted }) => {
console.log(deleted)
})Copy
{
"id": "<string>",
"object": "exchange",
"deleted": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The exchange's ID.
⌘I