Retrieve a list of the logged-in Customer's Orders. The orders can be filtered by fields such as status or fulfillment_status. The orders can also be paginated.
Request Request Example
Shell
JavaScript
Java
Swift
curl--location--request GET 'https://api.medusa-commerce.com/store/customers/me/orders'
Response Response Example
200 - Example 1
Request
Query Params
q
string
optional
term to search orders' display ID, email, shipping address's first name, customer's first name, customer's last name, and customer's phone number.
id
string
optional
Filter by ID.
status
array[string]
optional
Filter by status.
fulfillment_status
array[string]
optional
Fulfillment status to search for.
payment_status
array[string]
optional
Payment status to search for.
display_id
string
optional
Filter by display ID.
cart_id
string
optional
Filter by cart ID.
email
string
optional
Filter by email.
region_id
string
optional
Filter by region ID.
currency_code
string
optional
Filter by the 3 character ISO currency code of the order.
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:
["","",""]
limit
integer
optional
Limit the number of orders returned.
offset
integer
optional
The number of orders to skip when retrieving the orders.
expand
string
optional
Comma-separated relations that should be expanded in the returned orders.
fields
string
optional
Comma-separated fields that should be included in the returned orders.
Responses
🟢200OK
application/json
Body
The list of the customer's orders with pagination fields.
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) {56}]
required
An array of orders 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|null
optional
The total of shipping
Example:
1000
shipping_tax_total
integer
optional
The tax total applied on 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
item_tax_total
integer|null
optional
The tax total applied on items
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.
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
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.
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.
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.
discounts
array[object (Discount) {18}]
optional
The details of the discounts applied on the order.
gift_cards
array[object (Gift Card) {15}]
optional
The details of the gift card used in 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
items
array[object (Line Item) {42}]
optional
The details of the line items that belong to the order.
