Medusa
Store API
Admin API
Store API
Admin API
Discord
Twitter
Linkedin
Github
  1. Store API
  • 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
    • Get a Collection
      GET
  • Regions
    • List Regions
      GET
    • Get a Region
      GET
  • 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
  1. Store API

HTTP Compression

If you've enabled HTTP Compression in your Medusa configurations, and you want to disable it for some requests, you can pass the x-no-compression header in your requests:
If you're using the Medusa JS Client, you can pass custom headers in the last parameter of a method. For example:
medusa.products.list({}, {
  "x-no-compression": true
})
.then(({ products, limit, offset, count }) => {
  console.log(products.length)
})
You can also pass the header when you first initialize the Medusa client:
const medusa = new Medusa({
  maxRetries: 3,
  baseUrl: "https://api.example.com",
  customHeaders: {
    "x-no-compression": true
  }
})
For Medusa React, it's not possible to pass custom headers for a query or mutation, but you can pass the header to the MedusaProvider and it will be added to all subsequent requests:
import { MedusaProvider } from "medusa-react"

// define query client...

const App = () => {
  return (
    <MedusaProvider
      queryClientProviderProps={{ client: queryClient }}
      baseUrl="http://localhost:9000"
      // ...
      customHeaders={{
        "x-no-compression": true
      }}
    >
      <MyStorefront />
    </MedusaProvider>
  )
}
Modified at 2023-10-10 11:56:42
Previous
Authentication
Next
Publishable API Key
Built with