Overview
Scanner API
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.upload.retrieve("test.txt")
.then(({ file }) => {
console.log(file)
})Copy
{
"file": {
"id": "<string>",
"url": "<string>"
}
}Uploads
Get a File
Retrieve an uploaded file by its ID. You can expand the file’s relations or select the fields that should be returned.
GET
/
admin
/
uploads
/
{id}
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.upload.retrieve("test.txt")
.then(({ file }) => {
console.log(file)
})Copy
{
"file": {
"id": "<string>",
"url": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The upload's ID.
Query Parameters
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.
⌘I