How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Medusa Order Edits API

An order edit is a change to an order's details, such as items, shipping methods, and more.Changes made by an order edit are only applied on the order once they're confirmed.The order's previous version is retained due to versioning.These API routes allow admin users to make edits to an order and manage those edits.

Medusa Order Edits API is one of 82 APIs that Medusa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Order Edits. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 11 operations across 9 paths, and defines 83 schemas. It is described by OpenAPI 3.2.0, at version 2.19.0.

Requests are made against 2 base URLs: http://localhost:9000, https://api.medusajs.com.

11 operations 9 paths 83 schemas 3 DELETE8 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.19.0
Base URL
https://{medusa-backend-domain}
Authentication
HTTP Basic, HTTP Bearer, API Key, HTTP Bearer
License
Resource Areas
1

Authentication & Security 4

Medusa Order Edits API declares 4 security schemes for authenticating requests. It accepts HTTP basic authentication (api_token). It accepts HTTP bearer tokens (jwt_token). An API key is passed in the cookie as connect.sid (cookie_auth). It accepts HTTP bearer tokens (reset_password).

Paths & Operations 11

Across 9 paths, the API surfaces 11 operations — 3 DELETE, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Order Edits 11

An order edit is a change to an order's details, such as items, shipping methods, and more. Changes made by an order edit are only applied on the order once they're confirmed. The…

POST
/admin/order-edits
Create Order Edit
PostOrderEdits body → 200400401404409422500
DELETE
/admin/order-edits/{id}
Cancel Order Edit
DeleteOrderEditsId 1 param → 200400401404409422500
POST
/admin/order-edits/{id}/confirm
Confirm Order Edit
PostOrderEditsIdConfirm 1 param → 200400401404409422500
POST
/admin/order-edits/{id}/items
Add Items to Order Edit
PostOrderEditsIdItems 1 param body → 200400401404409422500
POST
/admin/order-edits/{id}/items/item/{item_id}
Update Order Item Quantity of Order Edit
PostOrderEditsIdItemsItemItem_id 2 params body → 200400401404409422500
POST
/admin/order-edits/{id}/items/{action_id}
Update an Item in an Order Edit
PostOrderEditsIdItemsAction_id 2 params body → 200400401404409422500
DELETE
/admin/order-edits/{id}/items/{action_id}
Remove Item from Order Edit
DeleteOrderEditsIdItemsAction_id 2 params → 200400401404409422500
POST
/admin/order-edits/{id}/request
Request Order Edit
PostOrderEditsIdRequest 1 param body → 200400401404409422500
POST
/admin/order-edits/{id}/shipping-method
Add Shipping Method to Order Edit
PostOrderEditsIdShippingMethod 1 param body → 200400401404409422500
POST
/admin/order-edits/{id}/shipping-method/{action_id}
Update Shipping Method of an Order Edit
PostOrderEditsIdShippingMethodAction_id 2 params body → 200400401404409422500
DELETE
/admin/order-edits/{id}/shipping-method/{action_id}
Remove Shipping Method from Order Edit
DeleteOrderEditsIdShippingMethodAction_id 2 params → 200400401404409422500

Schemas 83

The contract defines 83 schemas that model the data the API accepts and returns. The most detailed are AdminOrderPreview (54 properties), AdminOrder (52 properties), BaseOrder (48 properties), AdminOrderLinePreview (46 properties). Each schema is shown below with its type and property counts.

AdminProductOptionValue
object
The product option value's details.
9 properties 2 required
BaseCollection
object
The product collection's details.
9 properties 7 required
AdminRegionCountry
object
The country's details.
6 properties 1 required
BaseOrderItemDetail
object
The item's detail.
14 properties 14 required
BaseOrderAddress
object
An order address.
15 properties 4 required
AdminProductVariantInventoryItemLink
object
An association between a product variant and an inventory item.
6 properties 3 required
BaseRefundReason
object
The refund reason's details.
7 properties 5 required
AdminProductVariant
object
The product variant's details.
31 properties 22 required
BaseProductOption
object
The product option's details.
9 properties 3 required
Error
object
3 properties
AdminProductOption
object
The product option's details.
9 properties 3 required
BaseCapture
object
The details of a captured payment.
5 properties 4 required
AdminPostOrderEditsShippingReqSchema
object
The shipping method's details.
5 properties 1 required
AdminCustomerAddress
object
The customer's address.
18 properties 18 required
BaseProductOptionValue
object
The product option value's details.
9 properties 2 required
BaseCalculatedPriceSet
object
The calculated price's details.
14 properties 6 required
AdminOrderLineItem
object
The item's details.
44 properties 39 required
BaseOrderShippingMethodTaxLine
object
The tax line's details.
12 properties 9 required
AdminExchange
object
The exchange's details.
20 properties 8 required
BaseOrder
object
The order's details.
48 properties 40 required
AdminRequestOrderEdit
object
The details of the request to edit an order.
1 property
AdminOrderAddress
object
An order address.
16 properties 4 required
AdminOrderShippingMethod
object
The shipping method's details.
22 properties 18 required
AdminPaymentProvider
object
The payment provider's details.
2 properties 2 required
AdminProduct
object
The product's details.
34 properties 27 required
BasePaymentSession
object
The payment session's details.
10 properties 6 required
BaseRefund
object
The refund's details.
8 properties 4 required
AdminPostOrderEditsUpdateItemQuantityReqSchema
object
The order item's details to update.
5 properties 1 required
AdminProductCategory
object
The product category's details.
15 properties 13 required
BaseProductType
object
The product type's details.
7 properties 4 required
AdminCustomer
object
The customer's details.
16 properties 9 required
BaseProductCategory
object
The product category's details.
15 properties 13 required
AdminOrder
object
The order's details.
52 properties 41 required
AdminPostOrderEditsItemsActionReqSchema
object
The details to update in the item.
4 properties
AdminOrderPreview
object
A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
54 properties 42 required
BaseExchangeItem
object
The item's details.
9 properties 7 required
BaseOrderTransaction
object
An order transaction's details.
9 properties 9 required
AdminPrice
object
The price's details.
11 properties 11 required
AdminPostOrderEditsAddItemsReqSchema
object
The details of items to be edited.
1 property
AdminPaymentCollection
object
The payment collection's details.
14 properties 5 required
BaseOrderLineItemTaxLine
object
The tax line's tax lines.
12 properties 9 required
BaseProductVariant
object
The product variant's details.
28 properties 21 required
AdminSalesChannel
object
The sales channel's details.
8 properties 8 required
AdminProductImage
object
The image's details.
9 properties 3 required
AdminClaim
object
The claim's details.
20 properties 12 required
BaseProduct
object
The product's details.
31 properties 26 required
AdminPostOrderEditsShippingActionReqSchema
object
The shipping method's details.
3 properties
AdminOrderLinePreview
object
46 properties 40 required
AdminCollection
object
The product collection's details.
10 properties 7 required
BaseOrderFulfillment
object
The fulfillment's details.
15 properties 15 required
AdminShippingProfile
object
The shipping profile's details..
7 properties 7 required
AdminOrderFulfillment
object
The fulfillment's details.
15 properties 15 required
BaseClaimItem
object
The claim item's details.
11 properties 7 required
AdminOrderChangeAction
object
The order change action's details.
16 properties 16 required
AdminPayment
object
The payment's details.
16 properties 4 required
BaseOrderShippingMethodAdjustment
object
The adjustment's adjustments.
11 properties 7 required
AdminCustomerGroup
object
The customer group's details.
6 properties 6 required
AdminInventoryItem
object
The inventory item's details.
18 properties 4 required
BaseOrderShippingMethod
object
The shipping method's details.
22 properties 18 required
BaseProductImage
object
The image's details.
7 properties 3 required
AdminRegion
object
The region's details.
9 properties 3 required
AdminOrderEditResponse
object
An order edit's details.
1 property 1 required
AdminRefund
object
The refund's details.
8 properties 4 required
OrderCreditLine
object
The credit line's details.
9 properties 9 required
AdminInventoryLevel
object
The location level's location levels.
12 properties 11 required
AdminPostOrderEditsReqSchema
object
The order edit's details.
4 properties 1 required
AdminPaymentSession
object
The payment session's details.
10 properties 6 required
AdminOrderChange
object
The order change's details.
29 properties 26 required
AdminReturnItem
object
The return item's details.
9 properties 6 required
BaseOrderLineItem
object
The item's items.
44 properties 39 required
AdminProductType
object
The product type's details.
8 properties 4 required
BaseOrderShippingDetail
object
Details of changes to a shipping method.
8 properties 5 required
AdminOrderEditPreviewResponse
object
The preview of an order edit.
1 property 1 required
BasePaymentProvider
object
The payment provider's details.
1 property 1 required
BaseOrderChangeAction
object
The action's details.
BasePaymentCollection
object
The payment collection's details.
14 properties 5 required
AdminProductTag
object
The product tag's details.
8 properties 4 required
BaseOrderLineItemAdjustment
object
The adjustment's details.
11 properties 7 required
AdminReturn
object
The return's details.
16 properties 10 required
BaseProductTag
object
The product tag's details.
7 properties 4 required
BasePayment
object
The payment's details.
16 properties 4 required
AdminTranslation
object
The translation's details.
8 properties 8 required
BaseOrderSummary
object
The order's summary details.
7 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

medusa-order-edits-api-openapi.yml Raw ↑

Other APIs Medusa publishes across the network.

Medusa GraphQL API
Medusa MCP Remote Server
Medusa Api Keys API
Medusa Auth API
Medusa [auth Provider] API
Medusa Campaigns API
Medusa Carts API
Medusa Claims API
Medusa Collections API
Medusa Currencies API
Medusa Customer Groups API
Medusa Customers API
Where this information came from

This is an independent, third-party profile of Medusa Order Edits API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.