API Documentation
- Admin Api Keys
- Admin Campaigns
- Admin Claims
- Admin Collections
- Admin Currencies
- Admin Customer Groups
- Admin Customers
- Admin Draft Orders
- 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
- Admin Exchanges
- Admin Fulfillment Providers
- Admin Fulfillment Sets
- Admin Fulfillments
- Admin Gift Cards
- Admin Inventory Items
- Admin Invites
- Admin Notifications
- Admin Order Edits
- Admin Orders
- Admin Payment Collections
- Admin Payments
- Admin Plugins
- Admin Price Lists
- Admin Price Preferences
- Admin Product Categories
- Admin Product Tags
- Admin Product Types
- Admin Product Variants
- Admin Products
- Admin Promotions
- Admin Refund Reasons
- Admin Regions
- Admin Reservations
- Admin Return Reasons
- Admin Returns
- Admin Sales Channels
- Admin Shipping Options
- Admin Shipping Profiles
- Admin Stock Locations
- Admin Store Credit Accounts
- Admin Stores
- Admin Tax Providers
- Admin Tax Rates
- Admin Tax Regions
- Admin Transaction Groups
- Admin Uploads
- Admin Users
- Admin Workflows Executions
- Store Auth
- Admin Auth
- Store Carts
- Store Collections
- Store Currencies
- Store Customers
- Store Gift Cards
- Store Orders
- Store Payment Collections
- Store Payment Providers
- Store Product Categories
- Store Product Tags
- Store Product Types
- Store Products
- Store Regions
- Store Return Reasons
- Store
- Store Shipping Options
- Store Store Credit Accounts
- Admin Algolia
- Admin Attributes
- Admin Commission
- Admin Configuration
- Admin Order Sets
- Admin Requests
- Admin Return Request
- Admin Reviews
- Admin Sellers
- Auth
- Store Return Request
- Store Reviews
- Store Sellers
- Store Wishlist
- Vendor Attributes
- Vendor Campaigns
- Vendor Commission
- Vendor Configuration
- Vendor Customer Groups
- Vendor Customers
- Vendor Fulfillment Providers
- Vendor Fulfillment Sets
- Vendor Inventory Items
- Vendor Invites
- Vendor Current Member
- Vendor Members
- Vendor Notifications
- Vendor Orders
- Vendor Payout Account
- Vendor Payouts
- Vendor Price Lists
- Vendor Price Preferences
- Vendor Product Categories
- Vendor Product Collections
- Vendor Product Tags
- Vendor Product Types
- Vendor Products
- Vendor Promotions
- Vendor Regions
- Vendor Requests
- Vendor Reservations
- Vendor Return Requests
- Vendor Returns
- Vendor Sales Channels
- Vendor Sellers
- Vendor Onboarding
- Vendor Reviews
- Vendor Shipping Options
- Vendor Shipping Profiles
- Vendor Statistics
- Vendor Stock Locations
- Vendor Stores
Admin 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
Copy
import Medusa from "@medusajs/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)
})
Copy
This response does not have an example.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The draft order's ID.
Response
200
OK
Copy
import Medusa from "@medusajs/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)
})
Copy
This response does not have an example.
Assistant
Responses are generated using AI and may contain mistakes.