GET
/
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.list()
.then(({ price_lists, count, limit, offset }) => {
  console.log(price_lists)
})
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "price_lists": [
    {
      "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"
    }
  ],
  "estimate_count": 123
}

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.

​
offset
number

The number of items to skip when retrieving a list.

​
limit
number

Limit the number of items returned in the 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 -.

​
q
string

Search term to filter the price list's searchable properties.

​
id

Filter by a price list ID.

​
starts_at
object

Filter by a price list's start date.

​
ends_at
object

Filter by the price list's end date.

​
status
enum<string>[]

Filter by the price list's status.

​
rules_count
number[]

Filter by the price list's rules count.

The price list's rule count.

​
$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.

​
with_deleted
boolean

Whether to include deleted records in the result.

Response

OK

The paginated list of price lists.

​
limit
number
required

The maximum number of items returned.

​
offset
number
required

The number of items skipped before retrieving the returned items.

​
count
number
required

The total number of items.

​
price_lists
object[]
required

The list of price lists.

​
estimate_count
number

The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.