Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Order Edits
  • Auth
    • Get Current User
      GET
    • User Logout
      DELETE
    • User Login
      POST
    • User Login (JWT)
      POST
  • Apps Oauth
    • Generate Token for App
      POST
    • List Applications
      GET
  • Batch Jobs
    • Cancel a Batch Job
      POST
    • Get a Batch Job
      GET
    • Confirm a Batch Job
      POST
    • List Batch Jobs
      GET
    • Create a Batch Job
      POST
  • Currencies
    • List Currency
      GET
    • Update a Currency
      POST
  • Customers
    • Create a Customer
    • List Customers
    • Update a Customer
    • Get a Customer
  • Customer Groups
    • Remove Customers from Group
    • Add Customers to Group
    • List Customers
    • Create a Customer Group
    • List Customer Groups
    • Get a Customer Group
    • Delete a Customer Group
    • Update a Customer Group
  • Discounts
    • Create a Condition
    • Create a Discount
    • List Discounts
    • Get a Condition
    • Update a Condition
    • Delete a Condition
    • Create a Dynamic Code
    • Remove Batch Resources
    • Add Batch Resources
    • Get Discount by Code
    • Delete a Dynamic Code
    • Add Region to Discount
    • Remove Region
    • Delete a Discount
    • Update a Discount
    • Get a Discount
  • Draft Orders
    • Create a Line Item
    • Delete a Line Item
    • Update a Line Item
    • Update a Draft Order
    • Delete a Draft Order
    • Get a Draft Order
    • Create a Draft Order
    • List Draft Orders
    • Mark Paid
  • Gift Cards
    • Create a Gift Card
    • List Gift Cards
    • Delete a Gift Card
    • Get a Gift Card
    • Update a Gift Card
  • Inventory Items
    • Create an Inventory Item
    • List Inventory Items
    • List Inventory Level
    • Create an Location Level
    • Update an Inventory Item
    • Get an Inventory Item
    • Delete an Inventory Item
    • Update a Location Level
    • Delete a Location Level
  • Invites
    • Lists Invites
    • Create an Invite
    • Delete an Invite
    • Accept an Invite
    • Resend an Invite
  • Notes
    • List Notes
    • Create a Note
    • Get a Note
    • Delete a Note
    • Update a Note
  • Notifications
    • Resend Notification
    • List Notifications
  • Orders
    • Create a Reservation
    • Cancel Claim's Fulfillment
    • Ship a Claim's Fulfillment
    • Cancel Swap's Fulfilmment
    • Get Order Reservations
    • Add a Shipping Method
    • Create a Refund
    • Get an Order
    • Update an Order
    • Create a Fulfillment
    • Cancel a Swap
    • List Orders
    • Create a Swap
    • Complete an Order
    • Create a Swap Fulfillment
    • Cancel a Claim
    • Process a Swap Payment
    • Ship a Fulfillment
    • Capture an Order's Payments
    • Archive Order
    • Update a Claim
    • Request a Return
    • Create a Claim Fulfillment
    • Ship a Swap's Fulfillment
    • Cancel a Fulfilmment
    • Create a Claim
    • Cancel an Order
  • Order Edits
    • Delete a Line Item Change
      DELETE
    • Add a Line Item
      POST
    • Upsert Line Item Change
      POST
    • Delete Line Item
      DELETE
    • Cancel an Order Edit
      POST
    • Delete an Order Edit
      DELETE
    • Get an Order Edit
      GET
    • Update an Order Edit
      POST
    • Request Confirmation
      POST
    • Create an OrderEdit
      POST
    • List Order Edits
      GET
    • Confirm an OrderEdit
      POST
  • Payments
    • Capture a Payment
    • Get Payment details
    • Refund Payment
  • Payment Collections
    • Delete a Payment Collection
    • Get a Payment Collection
    • Update Payment Collection
    • Mark Authorized
  • Product Collections
    • Add Products to Collection
    • Remove Products from Collection
    • Get a Collection
    • Update a Collection
    • Delete a Collection
    • List Collections
    • Create a Collection
  • Product Tags
    • List Product Tags
  • Product Types
    • List Product Types
  • Product Variants
    • Get Variant's Inventory
    • List Product Variants
    • Get a Product variant
  • Price Lists
    • Delete a Product's Prices
    • List Products
    • Delete a Variant's Prices
    • Get a Price List
    • Update a Price List
    • Delete a Price List
    • Add or Update Prices
    • Delete Prices
    • Create a Price List
    • List Price Lists
  • Products
    • List Product Types
    • List Tags Usage Number
    • List a Product's Variants
    • Create a Product Variant
    • Update a Product Variant
    • Delete a Product Variant
    • Add a Product Option
    • Set Metadata
    • Delete a Product Option
    • Update a Product Option
    • List Products
    • Create a Product
    • Delete a Product
    • Update a Product
    • Get a Product
  • Product Categories
    • Create a Product Category
    • List Product Categories
    • Update a Product Category
    • Delete a Product Category
    • Get a Product Category
    • Add Products to a Category
    • Remove Products from Category
  • Publishable Api Keys
    • List Sales Channels
    • Delete Publishable API Key
    • Get a Publishable API Key
    • Revoke a Publishable API Key
    • Remove Sales Channels
    • Add Sales Channels
    • Update Publishable API Key
    • List Publishable API keys
    • Create Publishable API Key
  • Reservations
    • Delete a Reservation
    • Update a Reservation
    • Get a Reservation
    • Create a Reservation
    • List Reservations
  • Regions
    • List Fulfillment Options
    • Add Country
    • Remove Fulfillment Provider
    • Remove Payment Provider
    • Add Payment Provider
    • Delete a Region
    • Update a Region
    • Get a Region
    • List Regions
    • Create a Region
    • Add Fulfillment Provider
    • Remove Country
  • Return Reasons
    • Get a Return Reason
    • Delete a Return Reason
    • Update a Return Reason
    • List Return Reasons
    • Create a Return Reason
  • Returns
    • Receive a Return
    • List Returns
    • Cancel a Return
  • Sales Channels
    • Remove Stock Location from Sales Channels.
    • Associate a Stock Location
    • Get a Sales Channel
    • Delete a Sales Channel
    • Update a Sales Channel
    • Remove Products from Sales Channel
    • Add Products to Sales Channel
    • Create a Sales Channel
    • List Sales Channels
  • Shipping Options
    • Update Shipping Option
    • Get a Shipping Option
    • Delete Shipping Option
    • List Shipping Options
    • Create Shipping Option
  • Shipping Profiles
    • List Shipping Profiles
    • Create a Shipping Profile
    • Delete a Shipping Profile
    • Update a Shipping Profile
    • Get a Shipping Profile
  • Stock Locations
    • Get a Stock Location
    • List Stock Locations
    • Create a Stock Location
    • Update a Stock Location
    • Delete a Stock Location
  • Store
    • List Payment Providers
    • Add a Currency Code
    • Remove a Currency
    • List Tax Providers
    • Update Store Details
    • Get Store details
  • Swaps
    • Get a Swap
    • List Swaps
  • Uploads
    • Upload Files
    • Delete an Uploaded File
    • Get a File's Download URL
    • Protected File Upload
  • Tax Rates
    • Add to Shipping Options
    • Remove Shipping Options from Rate
    • Create a Tax Rate
    • List Tax Rates
    • Add to Products
    • Remove Products from Rate
    • Delete a Tax Rate
    • Get a Tax Rate
    • Update a Tax Rate
    • Add to Product Types
    • Remove Product Types from Rate
  • Users
    • Reset Password
    • Request Password Reset
    • Get a User
    • Delete a User
    • Update a User
    • Create a User
    • List Users
  1. Order Edits

Create an OrderEdit

POST
/admin/order-edits
Order Edits
Create an Order Edit.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.medusa-commerce.com/admin/order-edits' \
--header 'Content-Type: application/json' \
--data-raw ''
Response Response Example
200 - Example 1

Request

Body Params application/json
order_id
string 
required
The ID of the order to create the edit for.
internal_note
string 
optional
An optional note to associate with the order edit.
Examples

Responses

🟢200OK
application/json
Body
order_edit
object (Order Edit) 
required
Order edit allows modifying items in an order, such as adding, updating, or deleting items from the original order. Once the order edit is confirmed, the changes are reflected on the original order.
id
string 
required
The order edit's ID
Example:
oe_01G8TJSYT9M6AVS5N4EMNFS1EK
order_id
string 
required
The ID of the order that is edited
Example:
order_01G2SG30J8C85S4A5CHM2S1NS2
order
object  | null 
optional
The details of the order that this order edit was created for.
internal_note
string  | null 
required
An optional note with additional details about the order edit.
Example:
Included two more items B to the order.
created_by
string 
required
The unique identifier of the user or customer who created the order edit.
requested_by
string  | null 
required
The unique identifier of the user or customer who requested the order edit.
requested_at
string <date-time> | null 
required
The date with timezone at which the edit was requested.
confirmed_by
string  | null 
required
The unique identifier of the user or customer who confirmed the order edit.
confirmed_at
string <date-time> | null 
required
The date with timezone at which the edit was confirmed.
declined_by
string  | null 
required
The unique identifier of the user or customer who declined the order edit.
declined_at
string <date-time> | null 
required
The date with timezone at which the edit was declined.
declined_reason
string  | null 
required
An optional note why the order edit is declined.
canceled_by
string  | null 
required
The unique identifier of the user or customer who cancelled the order edit.
canceled_at
string <date-time> | null 
required
The date with timezone at which the edit was cancelled.
subtotal
integer 
optional
The total of subtotal
Example:
8000
discount_total
integer 
optional
The total of discount
Example:
800
shipping_total
integer 
optional
The total of the shipping amount
Example:
800
gift_card_total
integer 
optional
The total of the gift card amount
Example:
800
gift_card_tax_total
integer 
optional
The total of the gift card tax amount
Example:
800
tax_total
integer 
optional
The total of tax
Example:
0
total
integer 
optional
The total amount of the edited order.
Example:
8200
difference_due
integer 
optional
The difference between the total amount of the order and total amount of edited order.
Example:
8200
payment_collection_id
string  | null 
required
The ID of the payment collection
Example:
paycol_01G8TJSYT9M6AVS5N4EMNFS1EK
created_at
string <date-time>
required
The date with timezone at which the resource was created.
updated_at
string <date-time>
required
The date with timezone at which the resource was updated.
status
enum<string> 
required
The status of the order edit.
Allowed values:
confirmeddeclinedrequestedcreatedcanceled
items
array[object (Line Item) {42}] 
optional
The details of the cloned items from the original order with the new changes. Once the order edit is confirmed, these line items are associated with the original order.
changes
array[object (Order Item Change) {11}] 
optional
The details of all the changes on the original order's line items.
payment_collection
object (Payment Collection) 
optional
A payment collection allows grouping and managing a list of payments at one. This can be helpful when making additional payment for order edits or integrating installment payments.
🟠400Client Error or Multiple Errors
🟠401User is not authorized. Must log in first
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Modified at 2023-10-10 11:56:36
Previous
Request Confirmation
Next
List Order Edits
Built with