Overview
Scanner API
Admin API
- GETList Draft Orders
- POSTCreate Draft Order
- GETGet a Draft Order
- POSTUpdate a Draft Order
- DELDelete a Draft Order
- POSTConvert a Draft Order to an Order
- POSTCreate a Draft Order Edit
- DELCancel Edit on Draft Order
- POSTConfirm an Edit on a Draft Order
- POSTAdd Item to Draft Order Edit
- POSTUpdate Existing Item in Draft Order Edit
- POSTUpdate New Item in Draft Order Edit
- DELRemove Item from Draft Order Edit
- POSTAdd Promotions to Draft Order Edit
- DELRemove Promotions from Draft Order Edit
- POSTRequest Edit on Draft Order
- POSTAdd Shipping Method to Draft Order Edit
- POSTUpdate Existing Shipping Method in Draft Order Edit
- DELRemove Shipping Method from Draft Order Edit
- POSTUpdate New Shipping Method in Draft Order Edit
- DELRemove New Shipping Method from Draft Order
- 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.draftOrder.requestEdit("order_123")
.then(({ draft_order_preview }) => {
console.log(draft_order_preview)
})Draft Orders
Request Edit on Draft Order
Change the status of a draft order’s edit to be requested. Later, the edit can be confirmed or canceled.
POST
/
admin
/
draft-orders
/
{id}
/
edit
/
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.draftOrder.requestEdit("order_123")
.then(({ draft_order_preview }) => {
console.log(draft_order_preview)
})⌘I