Admin Api Keys
Admin Campaigns
Admin Claims
Admin Collections
Admin Currencies
Admin Customer Groups
Admin Customers
Admin Draft Orders
Admin Exchanges
Admin Fulfillment Providers
Admin Fulfillment Sets
Admin Fulfillments
Admin Gift Cards
Admin Inventory Items
Admin Invites
Admin Notifications
Admin Order Edits
Admin Orders
Admin Payment Collections
Admin Payments
Admin Plugins
Admin Price Lists
Admin Price Preferences
Admin Product Categories
Admin Product Tags
Admin Product Types
Admin Product Variants
Admin Products
- GET
  List Products
- POST
  Create Product
- POST
  Manage Products
- POST
  Export Products
- POST
  Create Product Import
  deprecated
- POST
  Confirm Product Import
  deprecated
- POST
  Create Product Import
- POST
  Confirm Product Import
- GET
  Get a Product
- POST
  Update a Product
- DEL
  Delete a Product
- GET
  List a Product's Options
- POST
  Create a Product Option
- GET
  Get a Product's Option
- POST
  Update a Product's Option
- DEL
  Delete an Option from Product
- GET
  List Variants of a Product
- POST
  Create a Product Variant
- POST
  Manage Variants in a Product
- POST
  Manage Variants Inventory in a Product
- GET
  Get Variant of a Product
- POST
  Update a Product Variant
- DEL
  Delete Product Variant
- POST
  Associate Variant with Inventory Item
- POST
  Update Product Variant's Inventory Details
- DEL
  Remove Inventory Item Association with Product Variant
- GET
  Get Product Applicable Attributes
Admin Promotions
Admin Refund Reasons
Admin Regions
Admin Reservations
Admin Return Reasons
Admin Returns
Admin Sales Channels
Admin Shipping Options
Admin Shipping Profiles
Admin Stock Locations
Admin Store Credit Accounts
Admin Stores
Admin Tax Providers
Admin Tax Rates
Admin Tax Regions
Admin Transaction Groups
Admin Uploads
Admin Users
Admin Workflows Executions
Store Auth
Admin Auth
Store Carts
Store Collections
Store Currencies
Store Customers
Store Gift Cards
Store Orders
Store Payment Collections
Store Payment Providers
Store Product Categories
Store Product Tags
Store Product Types
Store Products
Store Regions
Store Return Reasons
Store
Store Shipping Options
Store Store Credit Accounts
Admin Algolia
Admin Attributes
Admin Commission
Admin Configuration
Admin Order Sets
Admin Requests
Admin Return Request
Admin Reviews
Admin Sellers
Auth
Store Return Request
Store Reviews
Store Sellers
Store Wishlist
Vendor Attributes
Vendor Campaigns
Vendor Commission
Vendor Configuration
Vendor Customer Groups
Vendor Customers
Vendor Fulfillment Providers
Vendor Fulfillment Sets
Vendor Inventory Items
Vendor Invites
Vendor Current Member
Vendor Members
Vendor Notifications
Vendor Orders
Vendor Payout Account
Vendor Payouts
Vendor Price Lists
Vendor Price Preferences
Vendor Product Categories
Vendor Product Collections
Vendor Product Tags
Vendor Product Types
Vendor Products
Vendor Promotions
Vendor Regions
Vendor Requests
Vendor Reservations
Vendor Return Requests
Vendor Returns
Vendor Sales Channels
Vendor Sellers
Vendor Onboarding
Vendor Reviews
Vendor Shipping Options
Vendor Shipping Profiles
Vendor Statistics
Vendor Stock Locations
Vendor Stores

Admin Products

Export Products

Start a product export process to retrieve a CSV of exported products.

You’ll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to /admin/workflows-executions/export-products/:transaction-id. Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the /admin/notification API route to retrieve the file’s download URL.

POST

admin

products

export

import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.product.export({})
.then(({ transaction_id }) => {
  console.log(transaction_id)
})

{
  "transaction_id": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

fields

string

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.

Response

202

application/json

The details of the product export.

Manage Products Create Product Import

import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.product.export({})
.then(({ transaction_id }) => {
  console.log(transaction_id)
})

{
  "transaction_id": "<string>"
}

API Documentation

Authorizations

Query Parameters

Response