Medusa Exchanges API is one of 82 APIs that Medusa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Exchanges. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
18 operations
across 12 paths,
and defines 100 schemas.
It is described by OpenAPI 3.2.0, at version 2.19.0.
Requests are made against 2 base URLs: http://localhost:9000, https://api.medusajs.com.
The identity and technical contract details declared by the specification.
AdminProductOptionValue
object
The product option value's details.
9 properties
2 required
AdminExchangeReturnResponse
object
The details of an exchange's return.
2 properties
2 required
BaseCollection
object
The product collection's details.
9 properties
7 required
AdminRegionCountry
object
The country's details.
6 properties
1 required
BaseOrderItemDetail
object
The item's detail.
14 properties
14 required
BaseOrderAddress
object
An order address.
15 properties
4 required
AdminProductVariantInventoryItemLink
object
An association between a product variant and an inventory item.
6 properties
3 required
BaseRefundReason
object
The refund reason's details.
7 properties
5 required
AdminProductVariant
object
The product variant's details.
31 properties
22 required
OrderShippingMethodAdjustment
object
The shipping method adjustment's details.
12 properties
8 required
OrderTransaction
object
The transaction's details.
11 properties
11 required
AdminPostCancelExchangeReqSchema
object
The details of canceling an exchange.
1 property
BaseProductOption
object
The product option's details.
9 properties
3 required
AdminProductOption
object
The product option's details.
9 properties
3 required
Error
object
3 properties
BaseCapture
object
The details of a captured payment.
5 properties
4 required
AdminExchangeUpdateOutboundShipping
object
The details of the shipping method to update.
3 properties
OrderLineItemTaxLine
object
The line item tax line's details.
14 properties
9 required
AdminCustomerAddress
object
The customer's address.
18 properties
18 required
BaseProductOptionValue
object
The product option value's details.
9 properties
2 required
BaseCalculatedPriceSet
object
The calculated price's details.
14 properties
6 required
AdminOrderLineItem
object
The item's details.
44 properties
39 required
BaseOrderShippingMethodTaxLine
object
The tax line's details.
12 properties
9 required
AdminUpdateExchangeOutboundItem
object
The details to update in an outbound item.
2 properties
AdminExchange
object
The exchange's details.
20 properties
8 required
BaseOrder
object
The order's details.
48 properties
40 required
AdminExchangeDeleteResponse
object
The details of deleting an exchange.
3 properties
3 required
AdminOrderAddress
object
An order address.
16 properties
4 required
AdminOrderShippingMethod
object
The shipping method's details.
22 properties
18 required
AdminPaymentProvider
object
The payment provider's details.
2 properties
2 required
AdminProduct
object
The product's details.
34 properties
27 required
AdminExchangeUpdateInboundShipping
object
The details of the shipping method to update.
3 properties
BasePaymentSession
object
The payment session's details.
10 properties
6 required
BaseRefund
object
The refund's details.
8 properties
4 required
AdminExchangeAddOutboundShipping
object
The outbound shipping method's details.
5 properties
1 required
AdminPostReturnsShippingReqSchema
object
The shipping method's details.
5 properties
1 required
AdminProductCategory
object
The product category's details.
15 properties
13 required
BaseProductType
object
The product type's details.
7 properties
4 required
AdminCustomer
object
The customer's details.
16 properties
9 required
BaseProductCategory
object
The product category's details.
15 properties
13 required
AdminOrder
object
The order's details.
52 properties
41 required
Order
object
The order change's order.
51 properties
33 required
AdminOrderPreview
object
A preview of an order if a change, such as exchange, return, edit, or claim is applied on it.
54 properties
42 required
AdminAddExchangeOutboundItems
object
The details of outbound items.
1 property
BaseExchangeItem
object
The item's details.
9 properties
7 required
BaseOrderTransaction
object
An order transaction's details.
9 properties
9 required
AdminPrice
object
The price's details.
11 properties
11 required
AdminPostExchangesRequestItemsReturnActionReqSchema
object
The details to update in an inbound (returned) item.
4 properties
AdminPaymentCollection
object
The payment collection's details.
14 properties
5 required
BaseOrderLineItemTaxLine
object
The tax line's tax lines.
12 properties
9 required
BaseProductVariant
object
The product variant's details.
28 properties
21 required
AdminExchangePreviewResponse
object
A preview of the order once the exchange is applied.
2 properties
2 required
AdminCreateExchange
object
The exchange's details.
4 properties
1 required
AdminSalesChannel
object
The sales channel's details.
8 properties
8 required
AdminProductImage
object
The image's details.
9 properties
3 required
AdminClaim
object
The claim's details.
20 properties
12 required
BaseProduct
object
The product's details.
31 properties
26 required
AdminOrderLinePreview
object
46 properties
40 required
AdminCollection
object
The product collection's details.
10 properties
7 required
OrderAddress
object
The address's details.
15 properties
3 required
BaseOrderFulfillment
object
The fulfillment's details.
15 properties
15 required
AdminShippingProfile
object
The shipping profile's details..
7 properties
7 required
AdminOrderFulfillment
object
The fulfillment's details.
15 properties
15 required
BaseClaimItem
object
The claim item's details.
11 properties
7 required
AdminOrderChangeAction
object
The order change action's details.
16 properties
16 required
AdminExchangeResponse
object
The exchange's details.
1 property
1 required
AdminPayment
object
The payment's details.
16 properties
4 required
BaseOrderShippingMethodAdjustment
object
The adjustment's adjustments.
11 properties
7 required
AdminCustomerGroup
object
The customer group's details.
6 properties
6 required
AdminInventoryItem
object
The inventory item's details.
18 properties
4 required
BaseOrderShippingMethod
object
The shipping method's details.
22 properties
18 required
BaseProductImage
object
The image's details.
7 properties
3 required
AdminRegion
object
The region's details.
9 properties
3 required
AdminRefund
object
The refund's details.
8 properties
4 required
OrderCreditLine
object
The credit line's details.
9 properties
9 required
AdminInventoryLevel
object
The location level's location levels.
12 properties
11 required
AdminAddExchangeInboundItems
object
The details of the inbound (return) items.
2 properties
AdminPaymentSession
object
The payment session's details.
10 properties
6 required
AdminOrderChange
object
The order change's details.
29 properties
26 required
AdminReturnItem
object
The return item's details.
9 properties
6 required
BaseOrderLineItem
object
The item's items.
44 properties
39 required
AdminProductType
object
The product type's details.
8 properties
4 required
BaseOrderShippingDetail
object
Details of changes to a shipping method.
8 properties
5 required
OrderLineItem
object
The order line item's details.
44 properties
24 required
BasePaymentProvider
object
The payment provider's details.
1 property
1 required
BaseOrderChangeAction
object
The action's details.
BasePaymentCollection
object
The payment collection's details.
14 properties
5 required
AdminExchangeOrderResponse
object
The exchange's details.
2 properties
2 required
OrderLineItemAdjustment
object
The line item adjustment's details.
12 properties
8 required
AdminExchangeRequestResponse
object
The details of a requested exchange.
3 properties
3 required
AdminProductTag
object
The product tag's details.
8 properties
4 required
BaseOrderLineItemAdjustment
object
The adjustment's details.
11 properties
7 required
OrderShippingMethod
object
The shipping method's details.
21 properties
15 required
AdminReturn
object
The return's details.
16 properties
10 required
BaseProductTag
object
The product tag's details.
7 properties
4 required
BasePayment
object
The payment's details.
16 properties
4 required
AdminTranslation
object
The translation's details.
8 properties
8 required
BaseOrderSummary
object
The order's summary details.
7 properties
7 required
OrderItem
object
The order item's detail.
14 properties
14 required
OrderShippingMethodTaxLine
object
The shipping method tax line's details.
14 properties
9 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Medusa publishes across the network.
