Skip to main content

How to Use PriceList APIs

In this document, you’ll learn how to use the PriceList Admin APIs to create, update, and manage prices in a price list.

This document doesn't cover what price lists are and their basics. If you’re interested to learn about that, check out this documentation instead.

Prerequisites

Medusa Components

It is assumed that you already have a Medusa server installed and set up. If not, you can follow our quickstart guide to get started.

JS Client

This guide includes code snippets to send requests to your Medusa server using Medusa’s JS Client, JavaScript’s Fetch API, or cURL.

If you follow the JS Client code blocks, it’s assumed you already have Medusa’s JS Client installed and have created an instance of the client.

Authenticated Admin User

You must be an authenticated admin user before following along with the steps in the tutorial.

You can learn more about authenticating as an admin user in the API reference.


Create Price List

When you create a price list, you can specify different conditions to control when the price list can be applied.

In the body of your request, aside from the required fields, you can send the following fields to apply different conditions:

{
prices: [
{
region_id,
currency_code,
min_quantity,
max_quantity
}
],
customer_groups: [
{
id
}
]
}
Copy to Clipboard

You can learn more about what the conditions you can apply on a price list and its prices in this documentation.

For example, sending the following request creates a price list with two prices: one that is applied when the maximum quantity of the product variant in the cart is 3; another is applied when the minimum quantity of the same variant in the cart is 4:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
import { PriceListType } from "@medusajs/medusa"

medusa.admin.priceLists.create({
name: 'New Price List',
description: 'A new price list',
type: PriceListType.SALE,
status: 'active',
prices: [
{
amount: 1000,
variant_id,
currency_code: 'eur',
max_quantity: 3
},
{
amount: 1500,
variant_id,
currency_code: 'eur',
min_quantity: 4
}
]
})
.then(({ price_list }) => {
console.log(price_list.id);
});
Copy to Clipboard

This request returns the created price list.

You can check the full list of request body parameters in the API reference.


Get Price List’s Details

You can retrieve all of a price list’s details using the Get a Price List endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.priceLists.retrieve(priceListId)
.then(({ price_list }) => {
console.log(price_list.id);
});
Copy to Clipboard

Update a Price List

After creating a price list, you can update all of its fields including its status, prices, and more using the Update Price List endpoint.

For example, by sending the following request the end date of the price list will be updated:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.priceLists.update(priceListId, {
ends_at: '2022-10-11'
})
.then(({ price_list }) => {
console.log(price_list.id);
});
Copy to Clipboard

This request returns the updated price list.

For a full list of request body parameters, check out the API reference.


Manage Prices

Add Prices

You can add prices to your price list after creating it using the Update Prices endpoint.

You can also set the Copy to Clipboard request body parameter to Copy to Clipboard to replace the existing prices in the price list.

For example, sending the following request adds a new price to the price list:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.priceLists.addPrices(priceListId, {
prices: [
{
amount: 1200,
variant_id,
currency_code: 'eur'
}
]
})
.then(({ price_list }) => {
console.log(price_list.id);
});
Copy to Clipboard

This request returns the price list with the updated prices.

For a full list of request body parameters, check out the API reference.

Delete a Product’s Prices

You can delete all the prices of a product’s variants using the Delete Product Prices endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.priceLists.deleteProductPrices(priceListId, productId)
.then(({ ids, object, deleted }) => {
console.log(ids.length);
});
Copy to Clipboard

This request returns the IDs of the deleted prices.

Delete a Variant’s Prices

You can delete all the prices of a variant using the Delete Variant Prices endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.priceLists.deleteVariantPrices(priceListId, variantId)
.then(({ ids, object, deleted }) => {
console.log(ids);
});
Copy to Clipboard

This request returns the IDs of the deleted prices.


Delete Price List

You can delete a price list, and subsequently all prices defined in it, using the Delete Price List endpoint:

Report Incorrect CodeReport Incorrect CodeReport Incorrect CodeCopy to Clipboard
medusa.admin.priceLists.delete(priceListId)
.then(({ id, object, deleted }) => {
console.log(id);
});
Copy to Clipboard

This request returns the ID of the deleted price list.


What’s Next