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
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.updateShippingMethod("order_123", "action_123", {
shipping_option_id: "shipping_option_123",
})
.then(({ draft_order_preview }) => {
console.log(draft_order_preview)
})Update New Shipping Method in Draft Order Edit
Update a new shipping method that was added to a draft order edit using the ID of the method’s SHIPPING_ADD action.
Every shipping method has an actions property, whose value is an array of actions. You can check the action’s name using its action property, and use the value of the id property.
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.updateShippingMethod("order_123", "action_123", {
shipping_option_id: "shipping_option_123",
})
.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.
The ID of the shipping method's SHIPPING_ADD action.
Body
The updates to make on a changed shipping method.
The ID of the associated shipping option.
The custom amount of the shipping method. If not provided, the shipping option's amount will be used.
The shipping method's description.
A note viewed only by admin users about the shipping method.
The shipping method's metadata, can hold custom key-value pairs.
Response
OK