Overview
Scanner API
Admin API
- GETList Products
- POSTCreate Product
- POSTManage Products
- POSTExport Products
- POSTCreate Product Importdeprecated
- POSTConfirm Product Importdeprecated
- POSTCreate Product Import
- POSTConfirm Product Import
- GETGet a Product
- POSTUpdate a Product
- DELDelete a Product
- POSTManage Variants of Product Image
- GETList a Product's Options
- POSTCreate a Product Option
- GETGet a Product's Option
- POSTUpdate a Product's Option
- DELDelete an Option from Product
- GETList Variants of a Product
- POSTCreate a Product Variant
- POSTManage Variants in a Product
- POSTManage Variants Inventory in a Product
- GETGet Variant of a Product
- POSTUpdate a Product Variant
- DELDelete Product Variant
- POSTManage Images of Product Variant
- POSTAssociate Variant with Inventory Item
- POSTUpdate Product Variant's Inventory Details
- DELRemove Inventory Item Association with Product Variant
- 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.product.createImport({
file // uploaded File instance
})
.then(({ transaction_id }) => {
console.log(transaction_id)
})Copy
{
"transaction_id": "<string>",
"summary": {
"toCreate": 123,
"toUpdate": 123
}
}Products
Create Product Import
Create a new product import process. The products aren’t imported until the import is confirmed with the /admin/products/:transaction-id/imports API route.
POST
/
admin
/
products
/
imports
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.product.createImport({
file // uploaded File instance
})
.then(({ transaction_id }) => {
console.log(transaction_id)
})Copy
{
"transaction_id": "<string>",
"summary": {
"toCreate": 123,
"toUpdate": 123
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The details of the product's import file.
The name of the file as stored in the configured File Module Provider.
The file's original name.
The file's extension.
Example:
"csv"
The file's size in bytes.
The file's mime type.
Example:
"text/csv"
Response
OK
The import process's details.
The ID of the workflow execution's transaction. This is useful to confirm the import using the /admin/products/:transaction-id/import API route.
⌘I