Medusa
Store API
Admin API
Store API
Admin API
Schemas
Copy Page
Introduction
Authentication
HTTP Compression
Publishable API Key
Expanding Fields
Selecting Fields
Query Parameter Types
Pagination
Currencies
List Currencies
Get a Currency
Payment Providers
List Payment Providers
Return Reasons
List Return Reasons
Get a Return Reason
Auth
Retrieve Registration JWT Token
Authenticate Customer
Generate Reset Password Token for Customer
Refresh Authentication Token
Validate Authentication Callback
Delete Authentication Session
Set Authentication Session
Reset a Customer's Password
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
Request Order Transfer
Get an Order
Cancel Order Transfer
Decline Order Transfer
Accept Order Transfer
Payment Collections
Initialize Payment Session of a Payment Collection
Create Payment Collection
Shipping Options
Calculate Shipping Option Price
List Shipping Options for Cart
Schemas
Schemas
StoreCollection
StoreCurrency
StorePaymentProvider
StoreProductTag
StoreProductType
StoreReturnReason
BaseOrderSummary
BaseOrderTransaction
StoreCartAddress
StoreCartShippingMethod
StoreCartPromotion
StoreProductImage
BaseRegionCountry
AdminPaymentProvider
StoreRegion
StoreReturnItem
StoreReturn
AuthResponse
StoreOrderFulfillment
StoreCustomerAddress
StoreCustomer
AuthCallbackResponse
BaseFulfillmentProvider
StoreShippingOptionType
StoreShippingOption
StoreAddCartLineItem
StoreCartAddPromotion
StoreCartRemovePromotion
StoreUpdateCartLineItem
StoreUpdateCustomer
StoreCreateCustomer
StoreInitializePaymentSession
StoreAcceptOrderTransfer
StoreRequestOrderTransfer
StoreCreatePaymentCollection
StoreDeclineOrderTransferRequest
BaseCapture
BaseCalculatedPriceSet
StoreProductOptionValue
StoreProductOption
StoreProductVariant
StoreProduct
StoreRegionCountry
StoreOrderAddress
BaseOrderItemDetail
BaseOrderShippingDetail
StoreOrderShippingMethod
StoreCollectionResponse
StoreCurrencyListResponse
CreateAddress
UpdateAddress
UpdateCartData
StoreCustomerAddressResponse
StoreCurrencyResponse
StoreProductTypeListResponse
StoreCreateReturnShipping
StoreCreateReturnItem
StoreCreateReturn
StoreProductTagListResponse
StoreProductTypeResponse
StoreProductTagResponse
StoreReturnReasonResponse
RefundReason
BaseRefund
BasePayment
StoreCustomerAddressListResponse
StoreProductCategory
AuthStoreSessionResponse
StoreCustomerResponse
StoreCalculatedPrice
StoreReturnResponse
StorePaymentSession
StorePaymentCollection
StoreCartLineItem
StorePriceRule
StorePrice
StoreCartShippingOption
StoreShippingOptionResponse
StoreShippingOptionListResponse
StoreProductResponse
StoreCreateCart
StoreCart
StoreOrder
StoreProductCategoryListResponse
StoreProductCategoryResponse
StorePaymentCollectionResponse
StoreCartResponse
StoreOrderResponse
Response Error
Store API
Admin API
Store API
Admin API
Schemas
Copy Page
AuthResponse
The authentication's details.
{
"token"
:
"string"
}