Skip to main content
POST
/
admin
/
price-lists
JS SDK
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.priceList.create({
  title: "My Price List",
  status: "active",
  type: "sale",
  prices: [
    {
      variant_id: "variant_123",
      amount: 10,
      currency_code: "usd",
      rules: {
        region_id: "reg_123"
      }
    }
  ]
})
.then(({ price_list }) => {
  console.log(price_list)
})
{
  "price_list": {
    "id": "<string>",
    "title": "<string>",
    "description": "<string>",
    "rules": {},
    "starts_at": "<string>",
    "ends_at": "<string>",
    "status": "draft",
    "type": "sale",
    "prices": [
      {
        "variant_id": "<string>",
        "rules": {},
        "id": "<string>",
        "title": "<string>",
        "currency_code": "usd",
        "amount": 123,
        "raw_amount": {},
        "min_quantity": 123,
        "max_quantity": 123,
        "price_set_id": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z"
  }
}

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.

​
q
string

Apply a search query to the price list's searchable properties.

​
id

Filter by a specific price list ID.

​
starts_at
starts_at · object

Filter by a price list's start date.

​
ends_at
ends_at · object

Filter by a price list's end date.

​
status
enum<string>[]

Filter by price list statuses.

A price list status.

Available options:
draft,
active
​
rules_count
number[]

Filter by multiple price list rules count. Filter by price list rules count.

A price list's rules count.

​
limit
number

Limit the number of items returned in the list.

​
offset
number

The number of items to skip when retrieving a list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

​
with_deleted
boolean

The price list's with deleted.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Body

application/json

The price list's details.

​
title
string
required

The price list's title.

​
description
string
required

The price list's description.

​
starts_at
string<date-time>

The date and time the price list starts at.

​
ends_at
string<date-time>

The date and time the price list ends at.

​
status
enum<string>

The price list's status.

Available options:
active,
draft
​
type
enum<string>

The price list's type.

Available options:
sale,
override
​
rules
object

The price list's rules.

Example:
{ "product_category_id": "pcat_123" }
​
prices
object[]

The price list's prices.

Response

OK

The price list's details.

​
price_list
object
required

The price list's details.