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.addItems("order_123", {
items: [
{
variant_id: "variant_123",
quantity: 1,
},
],
})
.then(({ draft_order_preview }) => {
console.log(draft_order_preview)
})Draft Orders
Add Item to Draft Order Edit
Add an item to a draft order edit.
POST
/
admin
/
draft-orders
/
{id}
/
edit
/
items
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.addItems("order_123", {
items: [
{
variant_id: "variant_123",
quantity: 1,
},
],
})
.then(({ draft_order_preview }) => {
console.log(draft_order_preview)
})Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The draft order's ID.
Body
application/json
The details of the items to add to a draft order.
The items to add to the draft order.
Show child attributes
Show child attributes
The item's quantity.
The ID of the variant to add to the draft order.
The item's title.
The item's unit price.
The original price of the item before a promotion or sale.
A note viewed only by admin users about the item.
Whether the item can be purchased if it's out of stock.
The item's metadata, can hold custom key-value pairs.
Response
OK
⌘I