Medusa
Store APIAdmin API
Store APIAdmin API
Discord
Twitter
Linkedin
Github
  1. Orders
  • Introduction
  • Authentication
  • HTTP Compression
  • Publishable API Key
  • Expanding Fields
  • Selecting Fields
  • Query Parameter Types
  • Pagination
  • Currencies
    • List Currencies
      GET
    • Get a Currency
      GET
  • Payment Providers
    • List Payment Providers
      GET
  • Return Reasons
    • List Return Reasons
      GET
    • Get a Return Reason
      GET
  • Auth
    • Retrieve Registration JWT Token
      POST
    • Authenticate Customer
      POST
    • Generate Reset Password Token for Customer
      POST
    • Refresh Authentication Token
      POST
    • Validate Authentication Callback
      POST
    • Delete Authentication Session
      DELETE
    • Set Authentication Session
      POST
    • Reset a Customer's Password
      POST
  • Collections
    • List Collections
    • Get a Collection
  • Regions
    • List Regions
    • Get a Region
  • Products
    • List Products
    • Get a Product
  • Customers
    • Get Logged-in Customer
    • Update Customer
    • Create Address for Logged-In Customer
    • List Customer's Addresses
    • Get Customer's Address
    • Update Customer's Address
    • Remove Customer's Address
    • Register Customer
  • Product Tags
    • List Product Tags
    • Get a Product Tag
  • Returns
    • Create Return
  • Product Types
    • Get a Product Type
    • List Product Types
  • Product Categories
    • List Product Categories
    • Get a Product Category
  • Carts
    • Create Cart
    • Set Cart's Customer
    • Add Shipping Method to Cart
    • Add Line Item to Cart
    • Calculate Cart Taxes
    • Get a Cart
    • Update a Cart
    • Update a Line Item in a Cart
    • Remove Line Item from Cart
    • Complete Cart
    • Add Promotions to Cart
    • Remove Promotions from Cart
  • Orders
    • List Logged-in Customer's Orders
      GET
    • Request Order Transfer
      POST
    • Get an Order
      GET
    • Cancel Order Transfer
      POST
    • Decline Order Transfer
      POST
    • Accept Order Transfer
      POST
  • Payment Collections
    • Initialize Payment Session of a Payment Collection
    • Create Payment Collection
  • Shipping Options
    • Calculate Shipping Option Price
    • List Shipping Options for Cart
  1. Orders

Request Order Transfer

POST
/store/orders/{id}/transfer/request
Request an order to be transfered to the logged-in customer's account. The transfer is confirmed using the Accept Order Transfer API route.
Request Request Example
JavaScript
Shell
Java
Swift
curl --location -g --request POST '{{BASE_URL}}/store/orders//transfer/request' \
--header 'x-publishable-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "description": "string"
}'
Response Response Example
200 - Example 1

Request

Path Params
id
string 
required
The order's ID.
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.
Header Params
x-publishable-api-key
string 
required
Publishable API Key created in the Medusa Admin.
Body Params application/json
The details of requesting the order transfer.
description
string 
description
optional
The transfer's description, which can be shown to the other customer receiving the request.
Examples

Responses

🟢200OK
application/json
OK
Body
The order's details.
order
object (StoreOrder) 
required
The order's details.
id
string 
id
required
The order's ID.
region_id
string 
region_id
required
The ID of the associated region.
customer_id
string 
customer_id
required
The ID of the customer that placed the order.
sales_channel_id
string 
sales_channel_id
required
The ID of the sales channel the order was placed in.
email
string <email>
email
required
The email of the customer that placed the order.
currency_code
string 
currency_code
required
The order's currency code.
Example:
usd
display_id
number 
display_id
optional
The order's display ID.
metadata
object 
optional
The order's metadata, can hold custom key-value pairs.
created_at
string <date-time>
created_at
required
The date the order was created.
updated_at
string <date-time>
updated_at
required
The date the order was updated.
original_item_total
number 
original_item_total
required
The order items' total including taxes, excluding promotions.
original_item_subtotal
number 
original_item_subtotal
required
The order items' total excluding taxes, including promotions.
original_item_tax_total
number 
original_item_tax_total
required
The total taxes applied on the order items, excluding promotions.
item_total
number 
item_total
required
The order items' total including taxes and promotions.
item_subtotal
number 
item_subtotal
required
The order items' total excluding taxes, including promotions.
item_tax_total
number 
item_tax_total
required
The total taxes applied on the order's items, including promotions.
original_total
number 
original_total
required
The order's total including taxes, excluding promotions.
original_subtotal
number 
original_subtotal
required
The order's total excluding taxes, including promotions.
original_tax_total
number 
original_tax_total
required
The total taxes of the order excluding promotions.
total
number 
total
required
The order's total including taxes and promotions.
subtotal
number 
subtotal
required
The order's total excluding taxes, including promotions.
tax_total
number 
tax_total
required
The tax totals of the order including promotions.
discount_total
number 
discount_total
required
The order's discount total.
discount_tax_total
number 
discount_tax_total
required
The total taxes applied on the discounted amount.
gift_card_total
number 
gift_card_total
required
The order's gift card total.
gift_card_tax_total
number 
gift_card_tax_total
required
The total taxes applied on the gift card's amount.
shipping_total
number 
shipping_total
required
The order's shipping total including taxes and promotions.
shipping_subtotal
number 
shipping_subtotal
required
The order's shipping total excluding taxes, including promotions.
shipping_tax_total
number 
shipping_tax_total
required
The total taxes of the order's shipping including promotions.
original_shipping_total
number 
original_shipping_total
required
The order's shipping total including taxes, excluding promotions.
original_shipping_subtotal
number 
original_shipping_subtotal
required
The order's shipping total excluding taxes, including promotions.
original_shipping_tax_total
number 
original_shipping_tax_total
required
The total taxes of the order's shipping excluding promotions.
status
string 
status
required
The order's status.
payment_status
enum<string> 
required
The order's payment status.
Allowed values:
cancelednot_paidawaitingauthorizedpartially_authorizedcapturedpartially_capturedpartially_refundedrefundedrequires_action
fulfillment_status
enum<string> 
required
The order's fulfillment status.
Allowed values:
cancelednot_fulfilledpartially_fulfilledfulfilledpartially_shippedshippedpartially_delivereddelivered
transactions
array[object (BaseOrderTransaction) {9}] 
optional
The order's transactions.
fulfillments
array[object (StoreOrderFulfillment) {13}] 
optional
The order's fulfillments.
summary
object (BaseOrderSummary) 
required
The order's summary details.
customer
object (StoreCustomer) 
optional
The customer's details.
billing_address
object (StoreOrderAddress) 
optional
An order address
shipping_address
object (StoreOrderAddress) 
optional
An order address
items
$ref(#/definitions/7439038)[]
required
The order's items.
Could not resolve '#/definitions/7439038'
shipping_methods
array[object (StoreOrderShippingMethod) {22}] 
required
The order's shipping methods.
payment_collections
array[object (StorePaymentCollection) {14}] 
optional
The order's payment collections.
🟠400Bad Request
🟠401Unauthorized
🟠404Record Not Found
🟠409409
🟠422Parameter Error
🔴500Server Error
Modified at 2025-06-17 04:21:30
Previous
List Logged-in Customer's Orders
Next
Get an Order
Built with