Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Order Edits
  • Getting Started
    • Introduction
    • Authentication
    • HTTP Compression
    • Publishable API Key
    • Expanding Fields
    • Selecting Fields
    • Query Parameter Types
    • Pagination
  • Auth
    • Customer Login (JWT)
      POST
    • Customer Login (JWT)
      POST
    • Check if Email Exists
      GET
    • Get Current Customer
      GET
    • Customer Log out
      DELETE
    • Customer Login
      POST
  • Carts
    • Create Payment Sessions
      POST
    • Refresh a Payment Session
      POST
    • Create a Cart
      POST
    • Complete a Cart
      POST
    • Select a Payment Session
      POST
    • Delete a Payment Session
      DELETE
    • Update a Payment Session
      POST
    • Get a Cart
      GET
    • Update a Cart
      POST
    • Add Shipping Method
      POST
    • Update a Line Item
      POST
    • Delete a Line Item
      DELETE
    • Add a Line Item
      POST
    • Calculate Cart Taxes
      POST
    • Remove Discount
      DELETE
  • Customers
    • Request Password Reset
    • Get Saved Payment Methods
    • Add a Shipping Address
    • Update Customer
    • Get a Customer
    • Update a Shipping Address
    • Delete an Address
    • Create a Customer
    • Reset Password
    • List Orders
  • Gift Cards
    • Get Gift Card by Code
  • Orders
    • Claim Order
    • Verify Order Claim
    • Get an Order
    • Look Up an Order
    • Get by Cart ID
  • Order Edits
    • Complete an Order Edit
      POST
    • Retrieve an Order Edit
      GET
    • Decline an Order Edit
      POST
  • Payment Collections
    • Authorize Payment Session
    • Authorize Payment Sessions
    • Refresh a Payment Session
    • Get a PaymentCollection
    • Manage Payment Sessions
    • Create a Payment Session
  • Products
    • Search Products
    • List Products
    • Get a Product
  • Product Variants
    • Get a Product Variant
    • Get Product Variants
  • Product Tags
    • List Product Tags
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Product Collections
    • Get a Collection
    • List Collections
  • Product Types
    • List Product Types
  • Regions
    • List Regions
    • Get a Region
  • Returns
    • Create Return
  • Return Reasons
    • List Return Reasons
    • Get a Return Reason
  • Shipping Options
    • List for Cart
    • Get Shipping Options
  • Swaps
    • Get by Cart ID
    • Create a Swap
  1. Order Edits

Complete an Order Edit

POST
/store/order-edits/{id}/complete
Order Edits
Complete an Order Edit and reflect its changes on the original order. Any additional payment required must be authorized first using the Payment Collection API Routes.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.medusa-commerce.com/store/order-edits//complete'
Response Response Example
200 - Example 1

Request

Path Params
id
string 
required
The ID of the Order Edit.

Responses

🟢200OK
application/json
Body
The order edit's details.
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
🔴500Server Error
Modified at 2023-11-27 13:05:07
Previous
Get by Cart ID
Next
Retrieve an Order Edit
Built with