Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Draft Orders
  • Plugins
    • List Plugins
      GET
  • Auth
    • Refresh Authentication Token
      POST
    • Validate Authentication Callback
      POST
    • Generate Reset Password Token for Admin User
      POST
    • Retrieve Registration JWT Token
      POST
    • Authenticate User
      POST
    • Set Authentication Session
      POST
    • Delete Authentication Session
      DELETE
    • Reset an Admin User's Password
      POST
  • Draft Orders
    • Create a Draft Order Edit
      POST
    • Cancel Edit on Draft Order
      DELETE
    • Confirm an Edit on a Draft Order
      POST
    • Request Edit on Draft Order
      POST
    • Convert a Draft Order to an Order
      POST
    • Add Item to Draft Order Edit
      POST
    • Update Existing Item in Draft Order Edit
      POST
    • Remove Item from Draft Order Edit
      DELETE
    • Update New Item in Draft Order Edit
      POST
    • Add Promotions to Draft Order Edit
      POST
    • Remove Promotions from Draft Order Edit
      DELETE
    • Add Shipping Method to Draft Order Edit
      POST
    • Remove Shipping Method from Draft Order Edit
      DELETE
    • Update Existing Shipping Method in Draft Order Edit
      POST
    • Remove New Shipping Method from Draft Order
      DELETE
    • Update New Shipping Method in Draft Order Edit
      POST
    • Delete a Draft Order
      DELETE
    • Get a Draft Order
      GET
    • Update a Draft Order
      POST
    • Create Draft Order
      POST
    • List Draft Orders
      GET
  • Fulfillment Providers
    • List Fulfillment Options
    • List Fulfillment Providers
  • Fulfillment Sets
    • Delete Fulfillment Set
    • Add a Service Zone to a Fulfillment Set
    • Remove a Service Zone from Fulfillment Set
    • Get a Service Zone in a Fulfillment Set
    • Update the Service Zone of a Fulfillment Set
  • Inventory Items
    • Manage Inventory Levels
    • Manage Inventory Levels of Inventory Item
    • Create Inventory Level for Inventory Item
    • List Inventory Levels
    • Update an Inventory Level of an Inventory Item
    • Remove Inventory Level of Inventory Item
    • Create Inventory Item
    • List Inventory Items
    • Get a Inventory Item
    • Delete Inventory Item
    • Update an Inventory Item
  • Order Edits
    • Create Order Edit
    • Confirm Order Edit
    • Request Order Edit
    • Add Items to Order Edit
    • Update Order Item Quantity of Order Edit
    • Remove Item from Order Edit
    • Update an Item in an Order Edit
    • Add Shipping Method to Order Edit
    • Remove Shipping Method from Order Edit
    • Update Shipping Method of an Order Edit
    • Cancel Order Edit
  • Orders
    • List Changes on an Order
    • Mark a Fulfillment as Delivered.
    • Get Preview
    • Archive an Order
    • Cancel Order
    • Cancel Transfer Request
    • Create Credit Line for Order
    • Request Order Transfer
    • Complete Order
    • Update Order
    • Get an Order
    • List Line Items
    • Cancel Fulfillment
    • Create an Order Fulfillment
    • Create Shipment for an Order's Fulfillment
    • List Orders
  • Payment Collections
    • Delete a Payment Collection
    • Create Payment Collection
    • Mark a Payment Collection as Paid
  • Products
    • Create Product Import
    • Confirm Product Import
    • Export Products
    • Manage Products
    • Manage Variants in a Product
    • Associate Variant with Inventory Item
    • Remove Inventory Item Association with Product Variant
    • Update Product Variant's Inventory Details
    • Delete a Product
    • Get a Product
    • Update a Product
    • Create a Product Option
    • List a Product's Options
    • Get a Product's Option
    • Delete an Option from Product
    • Update a Product's Option
    • Get Variant of a Product
    • Delete Product Variant
    • Update a Product Variant
    • Manage Variants Inventory in a Product
    • Create a Product Variant
    • List Variants of a Product
    • Create Product
    • List Products
  • Claims
    • Get a Claim
    • Cancel a Claim
    • Add Inbound Items to a Claim
    • Remove an Inbound Item from Claim
    • Update Inbound Items of a Claim
    • Add an Inbound Shipping Method to a Claim
    • Cancel Claim Request
    • Confirm a Claim Request
    • Add Claim Items to a Claim
    • Remove a Claim Item from a Claim
    • Update a Claim Item
    • Remove Inbound Shipping Method from Claim
    • Update Inbound Shipping Method of a Claim
    • Add Outbound Items to a Claim
    • Remove an Outbound Item from Claim
    • Update Outbound Item of a Claim
    • Add Outbound Shipping Methods to a Claim
    • Remove Outbound Shipping Method from Claim
    • Update Outbound Shipping Method of a Claim
    • Create a Claim
    • List Claims
  • Currencies
    • Get a Currency
    • List Currencies
  • Exchanges
    • Get an Exchange
    • Cancel an Exchange
    • Add Inbound Items to an Exchange
    • Remove Inbound Item from Exchange
    • Update an Inbount Item of an Exchange
    • Add an Inbound Shipping Method to an Exchange
    • Cancel Exchange Request
    • Confirm an Exchange
    • Remove Inbound Shipping Method from Exchange
    • Update Inbound Shipping Method of an Exchange
    • Add Outbound Items to Exchange
    • Remove Outbound Item from Exchange
    • Update Outbound Item of an Exchange
    • Add Outbound Shipping Method to Exchange
    • Remove Outbound Shipping Method from Exchange
    • Update Outbound Shipping Method of Exchange
    • Create Exchange
    • List Exchanges
  • Fulfillments
    • Cancel a Fulfillment
    • Create Fulfillment
    • Create a Shipment for a Fulfillment
  • Invites
    • Refresh Invite Token
    • Get an Invite
    • Delete Invite
    • Accept Invite
    • Create Invite
    • List Invites
  • Notifications
    • Get a Notification
    • List Notifications
  • Payments
    • Get a Payment
    • Capture Payment
    • Refund Payment
    • List Payment Providers
    • List Payments
  • Returns
    • Cancel a return.
    • Get a Return
    • Update a Return
    • Add Damaged Items to Return
    • Remove Damaged Item from Return
    • Update Damaged Item of Return
    • Add Received Items to Return
    • Remove a Received Item from Return
    • Update a Received Item in a Return
    • Confirm Return Receival
    • Add Requested Items to Return
    • Remove Item from Return
    • Update Requested Item in Return
    • Add a Shipping Method to a Return
    • Remove Shipping Method from Return
    • Update a Shipping Method of a Return
    • Start Return Receival
    • Cancel Return Receival
    • Confirm Return Request
    • Cancel Return Request
    • Create Return
    • List Returns
  • Users
    • Get Logged-In User
    • Delete a User
    • Get a User
    • Update a User
    • List Users
  • Workflows Executions
    • Get a Workflows Execution
    • Subscribe to a Workflow's Execution
    • Get Workflow Execution's Details
    • Subscribe to Step of a Workflow's Execution
    • Fail a Step in a Workflow's Execution
    • Succeed a Step in a Workflow's Execution
    • List Workflows Executions
    • Execute a Workflow
  • Api Keys
    • Revoke API Key
    • Get API Key
    • Update an API Key
    • Delete an Api Key
    • Manage Sales Channels of a Publishable API Key
    • Create Api Key
    • List API Keys
  • Price Lists
    • Remove Products from Price List
    • Delete a Price List
    • Get a Price List
    • Update a Price List
    • Manage Prices in Price List
    • Create Price List
    • List Price Lists
  • Stores
    • Get a Store
    • Update a Store
    • List Stores
  • Tax Rates
    • Create Tax Rule for a Rate
    • Delete a Tax Rate
    • Get a Tax Rate
    • Update a Tax Rate
    • Remove Rule of Tax Rate
    • Create Tax Rate
    • List Tax Rates
  • Price Preferences
    • Delete a Price Preference
    • Get a Price Preference
    • Update a Price Preference
    • Create Price Preference
    • List Price Preferences
  • Return Reasons
    • Delete a Return Reason
    • Get a Return Reason
    • Update a Return Reason
    • Create Return Reason
    • List Return Reasons
  • Sales Channels
    • Delete a Sales Channel
    • Get a Sales Channel
    • Update a Sales Channel
    • Manage Products in Sales Channel
    • Create Sales Channel
    • List Sales Channels
  • Stock Locations
    • Delete a Stock Location
    • Get a Stock Location
    • Update a Stock Location
    • Add Fulfillment Set to Stock Location
    • Manage Fulfillment Providers of a Stock Location
    • Manage Sales Channels of a Stock Location
    • Create Stock Location
    • List Stock Locations
  • Tax Regions
    • Delete a Tax Region
    • Update a Tax Region
    • Get a Tax Region
    • Create Tax Region
    • List Tax Regions
  • Promotions
    • List Rule Attribute Options of a Rule Type
    • List Rules of a Promotion
    • List Rule Values Given a Rule Attribute
    • Manage the Buy Rules of a Promotion
    • Manage a Promotion's Rules
    • Manage Target Rules of a Promotion
    • Get a Promotion
    • Delete a Promotion
    • Update a Promotion
    • List Promotions
    • Create Promotion
  • Customer Groups
    • Get a Customer Group
    • Update a Customer Group
    • Delete a Customer Group
    • Manage Customers of a Customer Group
    • Create Customer Group
    • List Customer Groups
  • Product Tags
    • Delete a Product Tag
    • Get a Product Tag
    • Update a Product Tag
    • Create Product Tag
    • List Product Tags
  • Product Types
    • Delete a Product Type
    • Get a Product Type
    • Update a Product Type
    • Create Product Type
    • List Product Types
  • Refund Reasons
    • Get a Refund Reason
    • Update a Refund Reason
    • Delete a Refund Reason
    • Create Refund Reason
    • List Refund Reasons
  • Uploads
    • Get a File
    • Delete a File
    • Upload Files
  • Campaigns
    • Manage the Promotions of a Campaign
    • Get a Campaign
    • Delete a Campaign
    • Update a Campaign
    • List Campaigns
    • Create Campaign
  • Collections
    • Manage Products of a Collection
    • Delete a Collection
    • Get a Collection
    • Update a Collection
    • Create Collection
    • List Collections
  • Customers
    • Manage Customer Groups of Customer
    • Get a Customer
    • Delete a Customer
    • Update a Customer
    • List Addresses
    • Add a Customer Address
    • List Addresses
    • Remove an Address from Customer
    • Update a Customer's Address
    • Create Customer
    • List Customers
  • Product Categories
    • Manage Products in Product Category
    • Delete a Product Category
    • Get a Product Category
    • Update a Product Category
    • Create Product Category
    • List Product Categories
  • Reservations
    • Get a Reservation
    • Update a Reservation
    • Delete a Reservation
    • Create Reservation
    • List Reservations
  • Shipping Profiles
    • Delete a Shipping Profile
    • Get a Shipping Profile
    • Update a Shipping Profile
    • Create Shipping Profile
    • List Shipping Profiles
  • Regions
    • Get a Region
    • Delete a Region
    • Update a Region
    • Create Region
    • List Regions
  • Tax Providers
    • List Tax Providers
  • Shipping Options
    • Manage the Rules of a Shipping Option
    • Create Shipping Option
    • List Shipping Options
    • Delete a Shipping Option
    • Get a Shipping Option
    • Update a Shipping Option
  • Product Variants
    • List Product Variants
  1. Draft Orders

Create Draft Order

POST
/admin/draft-orders
Create a draft order. This creates an order with the is_draft_order property enabled. You can later convert the draft order to an order.
Request Request Example
JavaScript
Shell
Java
Swift
curl --location -g --request POST '{{BASE_URL}}/admin/draft-orders' \
--header 'Content-Type: application/json' \
--data-raw '{
    "sales_channel_id": "string",
    "email": "user@example.com",
    "customer_id": "string",
    "region_id": "string",
    "currency_code": "string",
    "no_notification_order": true,
    "metadata": {},
    "status": "completed",
    "promo_codes": [
        "string"
    ],
    "billing_address": {
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "company": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "country_code": "string",
        "postal_code": "string",
        "metadata": {},
        "province": "us-ca"
    },
    "shipping_address": {
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "company": "string",
        "address_1": "string",
        "address_2": "string",
        "city": "string",
        "country_code": "string",
        "postal_code": "string",
        "metadata": {},
        "province": "us-ca"
    },
    "shipping_methods": [
        {
            "shipping_method_id": "string",
            "name": "string",
            "option_id": "string",
            "data": {},
            "amount": "string"
        }
    ],
    "items": [
        {
            "title": "string",
            "sku": "string",
            "barcode": "string",
            "variant_id": "string",
            "quantity": 0,
            "metadata": {},
            "unit_price": "string"
        }
    ],
    "additional_data": {}
}'
Response Response Example
200 - Example 1

Request

Authorization
or
or
or
Query Params
fields
string 
fields
optional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Body Params application/json
The draft order's details.
sales_channel_id
string 
sales_channel_id
required
The ID of the associated sales channel.
email
string <email>
email
required
The email of the draft order's customer.
customer_id
string 
customer_id
required
The ID of the draft order's customer.
region_id
string 
region_id
required
The ID of the associated region.
currency_code
string 
currency_code
required
The draft order's currency code.
no_notification_order
boolean 
no_notification_order
optional
Whether to send the customer notifications on order changes.
metadata
object 
required
The draft order's metadata.
status
enum<string> 
status
optional
The draft order's status.
Allowed value:
completed
promo_codes
array[string]
optional
The promotion codes applied on the draft order.
billing_address
object 
optional
The billing address's details.
first_name
string 
first_name
required
The billing address's first name.
last_name
string 
last_name
required
The billing address's last name.
phone
string 
phone
required
The billing address's phone.
company
string 
company
required
The billing address's company.
address_1
string 
address_1
required
The billing address's first line.
address_2
string 
address_2
required
The billing address's second line.
city
string 
city
required
The billing address's city.
country_code
string 
country_code
required
The billing address's country code.
postal_code
string 
postal_code
required
The billing address's postal code.
metadata
object 
required
The billing address's metadata.
province
string 
province
required
The billing address's ISO 3166-2 province code. Must be lower-case.
Example:
us-ca
shipping_address
object 
optional
The draft order's shipping address.
first_name
string 
first_name
required
The shipping address's first name.
last_name
string 
last_name
required
The shipping address's last name.
phone
string 
phone
required
The shipping address's phone.
company
string 
company
required
The shipping address's company.
address_1
string 
address_1
required
The shipping address's first line.
address_2
string 
address_2
required
The shipping address's second line.
city
string 
city
required
The shipping address's city.
country_code
string 
country_code
required
The shipping address's country code.
postal_code
string 
postal_code
required
The shipping address's postal code.
metadata
object 
required
The shipping address's metadata.
province
string 
province
required
The shipping address's ISO 3166-2 province code. Must be lower-case.
Example:
us-ca
shipping_methods
array [object {5}] 
required
The draft order's shipping methods.
shipping_method_id
string 
shipping_method_id
optional
The ID of an existing shipping method.
name
string 
name
required
The shipping method's name.
option_id
string 
option_id
required
The ID of the shipping option this method is created from.
data
object 
optional
The shipping method's data, useful for fulfillment providers.
amount
required
items
array [object {7}] 
optional
The draft order's items.
title
string 
title
required
The item's title.
sku
string 
sku
required
The item's SKU.
barcode
string 
barcode
required
The item's barcode.
variant_id
string 
variant_id
required
The ID of the associated product variant.
quantity
number 
quantity
required
The item's ordered quantity.
metadata
object 
required
The item's metadata.
unit_price
required
additional_data
object 
optional
Pass additional custom data to the API route. This data is passed to the underlying workflow under the additional_data parameter.
Examples

Responses

🟢200OK
application/json
OK
Body
The draft order's details.
draft_order
object (AdminDraftOrder) 
required
The draft order's details.
sales_channel
object (AdminSalesChannel) 
optional
The sales channel's details.
customer
object (AdminCustomer) 
optional
The customer's details.
shipping_address
object (AdminOrderAddress) 
optional
An order address.
billing_address
object (AdminOrderAddress) 
optional
An order address.
summary
object (BaseOrderSummary) 
required
The order's summary details.
region
object (AdminRegion) 
optional
The region's details.
payment_collections
array[object (AdminPaymentCollection) {14}] 
required
The draft order's payment collections.
fulfillments
array[object (AdminOrderFulfillment) {13}] 
optional
The draft order's fulfillments.
items
array[object (AdminOrderLineItem) {44}] 
required
The draft order's items.
shipping_methods
array[object (AdminOrderShippingMethod) {22}] 
required
The draft order's shipping methods.
status
string 
status
required
The draft order's status.
currency_code
string 
currency_code
required
The draft order's currency code.
Example:
usd
id
string 
id
required
The draft order's ID.
version
number 
version
required
The draft order's version.
region_id
string 
region_id
required
The ID of the region associated with the draft order.
customer_id
string 
customer_id
required
The ID of the customer that the draft order belongs to.
sales_channel_id
string 
sales_channel_id
required
The ID of the sales channel that the draft order is placed in.
email
string <email>
email
required
The customer email associated with the draft order.
display_id
number 
display_id
optional
The draft order's display ID.
transactions
array[object (BaseOrderTransaction) {9}] 
optional
The draft order's transactions.
metadata
object 
optional
The draft order's metadata, can hold custom key-value pairs.
created_at
string <date-time>
created_at
required
The date the draft order was created.
updated_at
string <date-time>
updated_at
required
The date the draft order was updated.
original_item_total
number 
original_item_total
required
The total of the draft order's items including taxes, excluding promotions.
original_item_subtotal
number 
original_item_subtotal
required
The total of the draft order's items excluding taxes, including promotions.
original_item_tax_total
number 
original_item_tax_total
required
The tax total of the draft order's items excluding promotions.
item_total
number 
item_total
required
The total of the draft order's items including taxes and promotions.
item_subtotal
number 
item_subtotal
required
The total of the draft order's items excluding taxes, including promotions.
item_tax_total
number 
item_tax_total
required
The tax total of the draft order's items including promotions.
original_total
number 
original_total
required
The draft order's total excluding promotions, including taxes.
original_subtotal
number 
original_subtotal
required
The draft order's total excluding taxes, including promotions.
original_tax_total
number 
original_tax_total
required
The draft order's tax total, excluding promotions.
total
number 
total
required
The draft order's total including taxes and promotions.
subtotal
number 
subtotal
required
The draft order's total excluding taxes, including promotions.
tax_total
number 
tax_total
required
The draft order's tax total including promotions.
discount_total
number 
discount_total
required
The draft order's discount or promotions total.
discount_tax_total
number 
discount_tax_total
required
The tax total of draft order's discount or promotion.
gift_card_total
number 
gift_card_total
required
The draft order's gift card total.
gift_card_tax_total
number 
gift_card_tax_total
required
The tax total of the draft order's gift card.
shipping_total
number 
shipping_total
required
The draft order's shipping total including taxes and promotions.
shipping_subtotal
number 
shipping_subtotal
required
The draft order's shipping total excluding taxes, including promotions.
shipping_tax_total
number 
shipping_tax_total
required
The tax total of the draft order's shipping.
original_shipping_total
number 
original_shipping_total
required
The draft order's shipping total including taxes, excluding promotions.
original_shipping_subtotal
number 
original_shipping_subtotal
required
The draft order's shipping total excluding taxes, including promotions.
original_shipping_tax_total
number 
original_shipping_tax_total
required
The tax total of the draft order's shipping excluding promotions.
credit_lines
array[object (OrderCreditLine) {9}] 
optional
The draft order's credit lines.
payment_status
enum<string> 
required
The draft order's payment status.
Allowed values:
not_paidawaitingauthorizedpartially_authorizedcanceledcapturedpartially_capturedpartially_refundedrefundedrequires_action
fulfillment_status
enum<string> 
required
The draft order's fulfillment status.
Allowed values:
cancelednot_fulfilledpartially_fulfilledfulfilledpartially_shippedshippedpartially_delivereddelivered
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Modified at 2025-06-17 04:10:32
Previous
Update a Draft Order
Next
List Draft Orders
Built with