Cancel an order transfer that the logged-in customer previously requested using the Request Order Transfer API route.
Request Request Example
JavaScript
Shell
Java
Swift
curl--location-g--request POST '{{BASE_URL}}/store/orders//transfer/cancel' \
--header'x-publishable-api-key;'
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.
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.