List prices

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: prices } = await client.prices.list({
  price_list_id_eq: 'pl_xxx',
  currency_eq: 'USD',
  expand: ['variant'],
})

{
  "data": [
    {
      "id": "price_UkLWZg9DAJ",
      "currency": "USD",
      "amount": "19.99",
      "compare_at_amount": null,
      "price_list_id": null,
      "min_quantity": 1,
      "variant_id": "variant_UkLWZg9DAJ",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z"
    },
    {
      "id": "price_gbHJdmfrXB",
      "currency": "USD",
      "amount": "19.99",
      "compare_at_amount": null,
      "price_list_id": null,
      "min_quantity": 1,
      "variant_id": "variant_gbHJdmfrXB",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z"
    },
    {
      "id": "price_EfhxLZ9ck8",
      "currency": "USD",
      "amount": "5.00",
      "compare_at_amount": null,
      "price_list_id": "pl_UkLWZg9DAJ",
      "min_quantity": 1,
      "variant_id": "variant_gbHJdmfrXB",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 3,
    "pages": 1,
    "from": 1,
    "to": 3,
    "in": 3,
    "previous": null,
    "next": null
  }
}

GET

api

admin

prices

Spree Admin SDK

import { createAdminClient } from '@spree/admin-sdk'

const client = createAdminClient({
  baseUrl: 'https://your-store.com',
  secretKey: 'sk_xxx',
})

const { data: prices } = await client.prices.list({
  price_list_id_eq: 'pl_xxx',
  currency_eq: 'USD',
  expand: ['variant'],
})

{
  "data": [
    {
      "id": "price_UkLWZg9DAJ",
      "currency": "USD",
      "amount": "19.99",
      "compare_at_amount": null,
      "price_list_id": null,
      "min_quantity": 1,
      "variant_id": "variant_UkLWZg9DAJ",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z"
    },
    {
      "id": "price_gbHJdmfrXB",
      "currency": "USD",
      "amount": "19.99",
      "compare_at_amount": null,
      "price_list_id": null,
      "min_quantity": 1,
      "variant_id": "variant_gbHJdmfrXB",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z"
    },
    {
      "id": "price_EfhxLZ9ck8",
      "currency": "USD",
      "amount": "5.00",
      "compare_at_amount": null,
      "price_list_id": "pl_UkLWZg9DAJ",
      "min_quantity": 1,
      "variant_id": "variant_gbHJdmfrXB",
      "created_at": "2026-01-15T12:00:00.000Z",
      "updated_at": "2026-01-15T12:00:00.000Z"
    }
  ],
  "meta": {
    "page": 1,
    "limit": 25,
    "count": 3,
    "pages": 1,
    "from": 1,
    "to": 3,
    "in": 3,
    "previous": null,
    "next": null
  }
}

Filters

Filter with q[<attribute>_<predicate>]=value, for example q[amount_eq]=…. Send a list as q[<attribute>_in][]=a&q[<attribute>_in][]=b. How filters work.

Attribute	Kind	Predicates
`amount`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`compare_at_amount`	Amount	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`created_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`currency`	One of the `CurrencyCode` codes	`eq` `not_eq` `in` `not_in` `null` `not_null`
`id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`min_quantity`	Number	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`price_list_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`
`updated_at`	Date and time	`eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null`
`variant_id`	Prefixed ID	`eq` `not_eq` `in` `not_in` `null` `not_null`

Filters through associations

Prefix an associated record’s attribute with the association, as in q[price_list_id_eq]. The same predicates apply.

Prefix	Attributes
`price_list_`	`catalog_id`, `created_at`, `ends_at`, `id`, `match_policy`, `name`, `position`, `starts_at`, `status`, `updated_at`
`variant_`	`carton_package_type_id`, `carton_weight`, `cartons_per_pallet`, `cost_currency`, `cost_price`, `country_of_origin`, `created_at`, `deleted_at`, `depth`, `discontinue_on`, `height`, `hs_code`, `id`, `minimum_order_quantity`, `order_multiple`, `position`, `product_id`, `purchase_unit`, `sku`, `track_inventory`, `units_per_carton`, `updated_at`, `weight`, `width`
`variant_option_values_`	`created_at`, `id`, `label`, `name`, `position`, `updated_at`
`variant_product_`	`available_on`, `created_at`, `description`, `discontinue_on`, `id`, `name`, `price`, `seller_id`, `slug`, `status`, `updated_at`
`variant_seller_`	`contact_email`, `created_at`, `id`, `name`, `status`, `updated_at`
`variant_tax_category_`	`created_at`, `id`, `is_default`, `name`, `tax_code`, `updated_at`

Sort by: amount, compare_at_amount, created_at, currency, id, min_quantity, price_list_id, updated_at, variant_id. Prefix a field with - to sort descending.

Authorizations

x-spree-api-key

string

header

required

Secret API key for admin access

Authorization

string

header

required

JWT token for admin user authentication

Headers

x-spree-api-key

string

required

Authorization

string

required

Query Parameters

q[search]

string

Matches the variant's SKU, option value or product name, as variant search does.

page

integer

limit

integer

object

Attribute filters, as q[<attribute>_<predicate>]=value. See Filters above for the list.

sort

string

Comma-separated sort keys. Supports e.g. variant_product_name,variant_id.

expand

string

Comma-separated associations to embed. Supported: variant.

Response

200 - application/json

prices found

data

object[]

required

Show child attributes

API basics

Endpoints

Filters

Authorizations

Headers

Query Parameters

Response

​Filters

Authorizations

Headers

Query Parameters

Response

Filters