Medusa Orders API is one of 82 APIs that Medusa publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Order. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.
This API exposes
26 operations
across 25 paths,
and defines 111 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
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
BaseProductOption
object
The product option's details.
9 properties
3 required
Error
object
3 properties
AdminProductOption
object
The product option's details.
9 properties
3 required
BaseCapture
object
The details of a captured payment.
5 properties
4 required
AdminCustomerAddress
object
The customer's address.
18 properties
18 required
BaseProductOptionValue
object
The product option value's details.
9 properties
2 required
AdminOrderLineItem
object
The item's details.
44 properties
39 required
BaseCalculatedPriceSet
object
The calculated price's details.
14 properties
6 required
BaseOrderShippingMethodTaxLine
object
The tax line's details.
12 properties
9 required
AdminMarkOrderFulfillmentAsDelivered
object
The details of marking an order fulfillment as delivered.
1 property
AdminExchange
object
The exchange's details.
20 properties
8 required
BaseOrder
object
The order's details.
48 properties
40 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
BasePaymentSession
object
The payment session's details.
10 properties
6 required
BaseRefund
object
The refund's details.
8 properties
4 required
AdminProductCategory
object
The product category's details.
15 properties
13 required
BaseProductType
object
The product type's details.
7 properties
4 required
AdminFulfillmentDeliveryAddress
object
The address to deliver the items to.
11 properties
AdminOrderResponse
object
An order's details.
1 property
1 required
AdminCustomer
object
The customer's details.
16 properties
9 required
AdminOrderPreviewResponse
object
The preview of an order.
1 property
1 required
BaseProductCategory
object
The product category's details.
15 properties
13 required
AdminOrder
object
The order's details.
52 properties
41 required
AdminCreateOrderCreditLine
object
The details of a credit line to add to an order.
4 properties
3 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
BaseExchangeItem
object
The item's details.
9 properties
7 required
BaseOrderTransaction
object
An order transaction's details.
9 properties
9 required
AdminExportOrderResponse
object
The details of the order export.
1 property
1 required
AdminPrice
object
The price's details.
11 properties
11 required
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
AdminSalesChannel
object
The sales channel's details.
8 properties
8 required
AdminOrderItem
object
The order item's details.
5 properties
5 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
AdminUpdateOrder
object
The details to update in the order.
5 properties
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
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
AdminOrderChangesResponse
object
The details of an order's changes.
1 property
1 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
AdminRequestOrderTransfer
object
The details of the request to transfer the order.
4 properties
1 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
AdminPaymentSession
object
The payment session's details.
10 properties
6 required
AdminOrderChange
object
The order change's details.
29 properties
26 required
AdminAuthorizeOrderPaymentSession
object
The details for authorizing a payment session for an order.
1 property
1 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
AdminAuthorizeOrderPaymentSessionResponse
object
The details of the response after authorizing a payment session for an order.
2 properties
2 required
BaseOrderShippingDetail
object
Details of changes to a shipping method.
8 properties
5 required
AdminTransferOrderToGuest
object
The details of the order transfer to a guest.
3 properties
1 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
AdminProductTag
object
The product tag's details.
8 properties
4 required
BaseOrderLineItemAdjustment
object
The adjustment's details.
11 properties
7 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
StoreProductTag
object
The tag's details.
7 properties
4 required
StoreProductType
object
The product type's details.
7 properties
4 required
StoreAcceptOrderTransfer
object
The details of accepting the order transfer.
1 property
1 required
StoreProductOptionValue
object
The product option value's details.
9 properties
2 required
StorePaymentSession
object
The payment session's details.
10 properties
6 required
StoreOrderLineItem
object
The item's details.
44 properties
39 required
StoreProductVariant
object
The variant's details.
28 properties
21 required
StoreOrderShippingMethod
object
The shipping method's details.
22 properties
18 required
StoreOrderAddress
object
An order address
16 properties
4 required
StoreProduct
object
The product's details.
31 properties
26 required
StoreDeclineOrderTransfer
object
The details of declining the order transfer request.
1 property
1 required
StoreProductOption
object
The product option's details.
10 properties
3 required
StoreProductImage
object
The image's details.
7 properties
3 required
StoreCustomer
object
The customer's details.
13 properties
8 required
StorePaymentProvider
object
The payment provider's details
1 property
1 required
StoreCollection
object
The collection's details.
9 properties
7 required
StoreOrder
object
The order's details.
48 properties
39 required
StoreCustomerAddress
object
The customer address's details
18 properties
18 required
StoreRegionCountry
object
The country's details.
6 properties
1 required
StorePaymentCollection
object
The payment collection's details.
14 properties
5 required
StoreOrderFulfillment
object
The fulfillment's details.
15 properties
15 required
StoreRequestOrderTransfer
object
The details of requesting the order transfer.
2 properties
StoreOrderResponse
object
The order's details.
1 property
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Medusa publishes across the network.
