Medusa
  1. Orders
Medusa
  • Store API
  • Admin API
    • Auth
      • Apps Oauth
        • Generate Token for App
        • List Applications
      • Get Current User
        GET
      • User Logout
        DELETE
      • User Login
        POST
      • User Login (JWT)
        POST
    • 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
        POST
      • Cancel Claim's Fulfillment
        POST
      • Ship a Claim's Fulfillment
        POST
      • Cancel Swap's Fulfilmment
        POST
      • Get Order Reservations
        GET
      • Add a Shipping Method
        POST
      • Create a Refund
        POST
      • Get an Order
        GET
      • Update an Order
        POST
      • Create a Fulfillment
        POST
      • Cancel a Swap
        POST
      • List Orders
        GET
      • Create a Swap
        POST
      • Complete an Order
        POST
      • Create a Swap Fulfillment
        POST
      • Cancel a Claim
        POST
      • Process a Swap Payment
        POST
      • Ship a Fulfillment
        POST
      • Capture an Order's Payments
        POST
      • Archive Order
        POST
      • Update a Claim
        POST
      • Request a Return
        POST
      • Create a Claim Fulfillment
        POST
      • Ship a Swap's Fulfillment
        POST
      • Cancel a Fulfilmment
        POST
      • Create a Claim
        POST
      • Cancel an Order
        POST
    • Order Edits
      • Delete a Line Item Change
      • Add a Line Item
      • Upsert Line Item Change
      • Delete Line Item
      • Cancel an Order Edit
      • Delete an Order Edit
      • Get an Order Edit
      • Update an Order Edit
      • Request Confirmation
      • Create an OrderEdit
      • List Order Edits
      • Confirm an OrderEdit
    • 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
    • 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
      • Update a Stock Location
      • Delete a Stock Location
      • List Stock Locations
      • Create 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
  • 【Demo】Products
    • 检索产品列表
    • 创建新产品
    • 删除产品
    • 更新产品信息
    • 检索产品详情
  1. Orders

List Orders

GET
/admin/orders
Admin API/OrdersOrders
Retrieve a list of Orders. The orders can be filtered by fields such as status or display_id. The order can also be paginated.

Request

Query Params
q
string 
optional
term to search orders' shipping address, first name, email, and display ID
id
string 
optional
Filter by ID.
status
array[string]
optional
Filter by status
fulfillment_status
array[string]
optional
Filter by fulfillment status
payment_status
array[string]
optional
Filter by payment status
display_id
string 
optional
Filter by display ID
cart_id
string 
optional
Filter by cart ID
customer_id
string 
optional
Filter by customer ID
email
string 
optional
Filter by email
region_id
string 
optional
Filter by region IDs.
currency_code
string 
optional
Filter by currency codes.
tax_rate
string 
optional
Filter by tax rate.
lt
array[string]
optional
filter by dates less than this date
Example:
["","",""]
gt
array[string]
optional
filter by dates greater than this date
Example:
["","",""]
lte
array[string]
optional
filter by dates less than or equal to this date
Example:
["","",""]
gte
array[string]
optional
filter by dates greater than or equal to this date
Example:
["","",""]
sales_channel_id
array[string]
optional
Filter by Sales Channel IDs
offset
integer 
optional
The number of orders to skip when retrieving the orders.
limit
integer 
optional
Limit the number of orders returned.
expand
string 
optional
Comma-separated relations that should be expanded in the returned order.
fields
string 
optional
Comma-separated fields that should be included in the returned order.

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/admin/orders'

Responses

🟢200OK
application/json
Body
count
integer 
required
The total number of items available
offset
integer 
required
The number of orders skipped when retrieving the orders.
limit
integer 
required
The number of items per page
orders
array[object (Order) {54}] 
required
An array of order details.
id
string 
required
The order's ID
Example:
order_01G8TJSYT9M6AVS5N4EMNFS1EK
display_id
integer 
required
The order's display ID
Example:
2
cart_id
string  | null 
required
The ID of the cart associated with the order
Example:
cart_01G8ZH853Y6TFXWPG5EYE81X63
cart
object  | null 
optional
The details of the cart associated with the order.
customer_id
string 
required
The ID of the customer associated with the order
Example:
cus_01G2SG30J8C85S4A5CHM2S1NS2
customer
object  | null 
optional
The details of the customer associated with the order.
email
string <email>
required
The email associated with the order
billing_address_id
string  | null 
required
The ID of the billing address associated with the order
Example:
addr_01G8ZH853YPY9B94857DY91YGW
shipping_address_id
string  | null 
required
The ID of the shipping address associated with the order
Example:
addr_01G8ZH853YPY9B94857DY91YGW
region_id
string 
required
The ID of the region this order was created in.
Example:
reg_01G1G5V26T9H8Y0M4JNE3YGA4G
tax_rate
number  | null 
required
The order's tax rate
Example:
0
draft_order_id
string  | null 
required
The ID of the draft order this order was created from.
Example:
null
draft_order
object  | null 
optional
The details of the draft order this order was created from.
canceled_at
string <date-time> | null 
required
The date the order was canceled on.
no_notification
boolean  | null 
required
Flag for describing whether or not notifications related to this should be send.
Example:
false
external_id
string  | null 
required
The ID of an external order.
Example:
null
sales_channel_id
string  | null 
optional
The ID of the sales channel this order belongs to.
Example:
null
shipping_total
integer 
optional
The total of shipping
Example:
1000
raw_discount_total
integer 
optional
The total of discount
Example:
800
discount_total
integer 
optional
The total of discount rounded
Example:
800
tax_total
integer 
optional
The total of tax
Example:
0
refunded_total
integer 
optional
The total amount refunded if the order is returned.
Example:
0
total
integer 
optional
The total amount of the order
Example:
8200
subtotal
integer 
optional
The subtotal of the order
Example:
8000
paid_total
integer 
optional
The total amount paid
Example:
8000
refundable_amount
integer 
optional
The amount that can be refunded
Example:
8200
gift_card_total
integer 
optional
The total of gift cards
Example:
0
gift_card_tax_total
integer 
optional
The total of gift cards with taxes
Example:
0
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 order's status
Allowed values:
pendingcompletedarchivedcanceledrequires_action
Default:
pending
fulfillment_status
enum<string> 
required
The order's fulfillment status
Allowed values:
not_fulfilledpartially_fulfilledfulfilledpartially_shippedshippedpartially_returnedreturnedcanceledrequires_action
Default:
not_fulfilled
payment_status
enum<string> 
required
The order's payment status
Allowed values:
not_paidawaitingcapturedpartially_refundedrefundedcanceledrequires_action
Default:
not_paid
currency_code
string 
required
The 3 character currency code that is used in the order
Example:
usd
payments
array [object] 
optional
The details of the payments used in the order.
fulfillments
array [object] 
optional
The details of the fulfillments created for the order.
returns
array [object] 
optional
The details of the returns created for the order.
claims
array [object] 
optional
The details of the claims created for the order.
refunds
array [object] 
optional
The details of the refunds created for the order.
swaps
array [object] 
optional
The details of the swaps created for the order.
edits
array [object] 
optional
The details of the order edits done on the order.
idempotency_key
string  | null 
required
Randomly generated key used to continue the processing of the order in case of failure.
metadata
object  | null 
required
An optional key-value map with additional details
Example:
{"car":"white"}
gift_card_transactions
array[object (Gift Card Transaction) {9}] 
optional
The gift card transactions made in the order.
currency
object (Currency) 
optional
Currency
sales_channel
object (Sales Channel) 
optional
A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.
billing_address
object (Address) 
optional
An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
shipping_address
object (Address) 
optional
An address is used across the Medusa backend within other schemas and object types. For example, a customer's billing and shipping addresses both use the Address entity.
shipping_methods
array[object (Shipping Method) {20}] 
optional
The details of the shipping methods used in the order.
region
object (Region) 
optional
A region holds settings specific to a geographical location, including the currency, tax rates, and fulfillment and payment providers. A Region can consist of multiple countries to accomodate common shopping settings across countries.
gift_cards
array[object (Gift Card) {15}] 
optional
The details of the gift card used in the order.
discounts
array[object (Discount) {18}] 
optional
The details of the discounts applied on the order.
items
array[object (Line Item) {42}] 
optional
The details of the line items that belong to the order.
returnable_items
array[object (Line Item) {42}] 
optional
The details of the line items that are returnable as part of the order, swaps, or claims
Example
🟠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 2024-05-23 07:10:14
Previous
Cancel a Swap
Next
Create a Swap
Built with