- Auth
- Apps Oauth
- Batch Jobs
- Currencies
- Customers
- Customer Groups
- Discounts
- Draft Orders
- Gift Cards
- Inventory Items
- Invites
- Notes
- Notifications
- Orders
- Create a ReservationPOST
- Cancel Claim's FulfillmentPOST
- Ship a Claim's FulfillmentPOST
- Cancel Swap's FulfilmmentPOST
- Get Order ReservationsGET
- Add a Shipping MethodPOST
- Create a RefundPOST
- Get an OrderGET
- Update an OrderPOST
- Create a FulfillmentPOST
- Cancel a SwapPOST
- List OrdersGET
- Create a SwapPOST
- Complete an OrderPOST
- Create a Swap FulfillmentPOST
- Cancel a ClaimPOST
- Process a Swap PaymentPOST
- Ship a FulfillmentPOST
- Capture an Order's PaymentsPOST
- Archive OrderPOST
- Update a ClaimPOST
- Request a ReturnPOST
- Create a Claim FulfillmentPOST
- Ship a Swap's FulfillmentPOST
- Cancel a FulfilmmentPOST
- Create a ClaimPOST
- Cancel an OrderPOST
- Order Edits
- Payments
- Payment Collections
- Product Collections
- Product Tags
- Product Types
- Product Variants
- Price Lists
- Products
- Product Categories
- Publishable Api Keys
- Reservations
- Regions
- Return Reasons
- Returns
- Sales Channels
- Shipping Options
- Shipping Profiles
- Stock Locations
- Store
- Swaps
- Uploads
- Tax Rates
- Users
Update an Order
POST
/admin/orders/{id}
Orders
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.medusa-commerce.com/admin/orders/' \
--header 'Content-Type: application/json' \
--data-raw ''Response Response Example
200 - Example 1
Request
Path Params
id
string
required
Query Params
expand
string
optional
fields
string
optional
Body Params application/json
email
string
optional
region
string
optional
customer_id
string
optional
no_notification
boolean
optional
true, no notification will be sent to the customer related to this order.payment_method
object
optional
provider_id
string
optional
data
object
optional
billing_address
object (AddressPayload)
optional
first_name
string
optional
Example:
Arno
last_name
string
optional
Example:
Willms
phone
string
optional
Example:
16128234334802
company
string
optional
address_1
string
optional
Example:
14433 Kemmer Court
address_2
string
optional
Example:
Suite 369
city
string
optional
Example:
South Geoffreyview
province
string
optional
Example:
Kentucky
postal_code
string
optional
Example:
72093
country_code
string
optional
Example:
st
metadata
object
optional
Example:
{"car":"white"}
shipping_address
object (AddressPayload)
optional
discounts
array[object (Discount) {18}]
optional
id
string
required
Example:
disc_01F0YESMW10MGHWJKZSDDMN0VN
code
string
required
Example:
10DISC
is_dynamic
boolean
required
Example:
false
rule_id
string | null
required
Example:
dru_01F0YESMVK96HVX7N419E3CJ7C
is_disabled
boolean
required
Example:
false
parent_discount_id
string | null
required
Example:
disc_01G8ZH853YPY9B94857DY91YGW
parent_discount
object | null
optional
starts_at
string <date-time>
required
ends_at
string <date-time> | null
required
valid_duration
string | null
required
Example:
P3Y6M4DT12H30M5S
usage_limit
integer | null
required
Example:
100
usage_count
integer
required
Default:
0
Example:
50
created_at
string <date-time>
required
updated_at
string <date-time>
required
deleted_at
string <date-time> | null
required
metadata
object | null
required
Example:
{"car":"white"}
rule
object (Discount Rule)
optional
regions
array[object (Region) {19}]
optional
items
array[object (Line Item) {42}]
optional
id
string
required
Example:
item_01G8ZC9GWT6B2GP5FSXRXNFNGN
cart_id
string | null
required
Example:
cart_01G8ZH853Y6TFXWPG5EYE81X63
cart
object | null
optional
order_id
string | null
required
Example:
order_01G8TJSYT9M6AVS5N4EMNFS1EK
order
object | null
optional
swap_id
string | null
required
Example:
null
swap
object | null
optional
claim_order_id
string | null
required
Example:
null
claim_order
object | null
optional
original_item_id
string | null
required
order_edit_id
string | null
required
order_edit
object | null
optional
title
string
required
Example:
Medusa Coffee Mug
description
string | null
required
Example:
One Size
thumbnail
string <uri> | null
required
Example:
https://medusa-public-images.s3.eu-west-1.amazonaws.com/coffee-mug.png
is_return
boolean
required
Default:
false
is_giftcard
boolean
required
Default:
false
should_merge
boolean
required
Default:
true
allow_discounts
boolean
required
Default:
true
has_shipping
boolean | null
required
Example:
false
unit_price
integer
required
Example:
8000
variant_id
string | null
required
Example:
variant_01G1G5V2MRX2V3PVSR2WXYPFB6
quantity
integer
required
Example:
1
fulfilled_quantity
integer | null
required
Example:
0
returned_quantity
integer | null
required
Example:
0
shipped_quantity
integer | null
required
Example:
0
refundable
integer
optional
Example:
0
subtotal
integer
optional
Example:
8000
tax_total
integer
optional
Example:
0
total
integer
optional
Example:
8000
original_total
integer
optional
Example:
8000
original_tax_total
integer
optional
Example:
0
discount_total
integer
optional
Example:
0
raw_discount_total
integer
optional
Example:
0
gift_card_total
integer
optional
Example:
0
includes_tax
boolean
optional
Default:
false
created_at
string <date-time>
required
updated_at
string <date-time>
required
metadata
object | null
required
Example:
{"car":"white"}
tax_lines
array[object (Line Item Tax Line) {9}]
optional
variant
object (Product Variant)
optional
adjustments
array[object (Line Item Adjustment) {8}]
optional
shipping_method
object
optional
provider_id
string
optional
profile_id
string
optional
price
integer
optional
data
object
optional
items
array[object (Line Item) {42}]
optional
Examples
Responses
🟢200OK
application/json
Body
order
object (Order)
required
id
string
required
Example:
order_01G8TJSYT9M6AVS5N4EMNFS1EK
display_id
integer
required
Example:
2
cart_id
string | null
required
Example:
cart_01G8ZH853Y6TFXWPG5EYE81X63
cart
object | null
optional
customer_id
string
required
Example:
cus_01G2SG30J8C85S4A5CHM2S1NS2
customer
object | null
optional
email
string <email>
required
billing_address_id
string | null
required
Example:
addr_01G8ZH853YPY9B94857DY91YGW
shipping_address_id
string | null
required
Example:
addr_01G8ZH853YPY9B94857DY91YGW
region_id
string
required
Example:
reg_01G1G5V26T9H8Y0M4JNE3YGA4G
tax_rate
number | null
required
Example:
0
draft_order_id
string | null
required
Example:
null
draft_order
object | null
optional
canceled_at
string <date-time> | null
required
no_notification
boolean | null
required
Example:
false
external_id
string | null
required
Example:
null
sales_channel_id
string | null
optional
Example:
null
shipping_total
integer
optional
Example:
1000
raw_discount_total
integer
optional
Example:
800
discount_total
integer
optional
Example:
800
tax_total
integer
optional
Example:
0
refunded_total
integer
optional
Example:
0
total
integer
optional
Example:
8200
subtotal
integer
optional
Example:
8000
paid_total
integer
optional
Example:
8000
refundable_amount
integer
optional
Example:
8200
gift_card_total
integer
optional
Example:
0
gift_card_tax_total
integer
optional
Example:
0
created_at
string <date-time>
required
updated_at
string <date-time>
required
status
enum<string>
required
Allowed values:
pendingcompletedarchivedcanceledrequires_action
Default:
pending
fulfillment_status
enum<string>
required
Allowed values:
not_fulfilledpartially_fulfilledfulfilledpartially_shippedshippedpartially_returnedreturnedcanceledrequires_action
Default:
not_fulfilled
payment_status
enum<string>
required
Allowed values:
not_paidawaitingcapturedpartially_refundedrefundedcanceledrequires_action
Default:
not_paid
currency_code
string
required
Example:
usd
payments
array [object]
optional
fulfillments
array [object]
optional
returns
array [object]
optional
claims
array [object]
optional
refunds
array [object]
optional
swaps
array [object]
optional
edits
array [object]
optional
idempotency_key
string | null
required
metadata
object | null
required
Example:
{"car":"white"}
gift_card_transactions
array[object (Gift Card Transaction) {9}]
optional
currency
object (Currency)
optional
sales_channel
object (Sales Channel)
optional
billing_address
object (Address)
optional
shipping_address
object (Address)
optional
shipping_methods
array[object (Shipping Method) {20}]
optional
region
object (Region)
optional
gift_cards
array[object (Gift Card) {15}]
optional
discounts
array[object (Discount) {18}]
optional
items
array[object (Line Item) {42}]
optional
returnable_items
array[object (Line Item) {42}]
optional
🟠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