Update a price list

import { createAdminClient } from '@spree/admin-sdk' const client = createAdminClient({ baseUrl: 'https://your-store.com', secretKey: 'sk_xxx', }) const priceList = await client.priceLists.update('pl_xxx', { name: 'Wholesale (Q3)', })

{ "id": "pl_UkLWZg9DAJ", "name": "Wholesale (Q3)", "description": null, "status": "draft", "position": 1, "match_policy": "all", "adjust_compare_at": false, "starts_at": null, "ends_at": null, "deleted_at": null, "created_at": "2026-01-15T12:00:00.000Z", "updated_at": "2026-01-15T12:00:00.000Z", "price_adjustment_percentage": null, "automatic_pricing": false, "currently_active": false, "products_count": 0, "prices_count": 0, "price_adjustment_tiers": [] }

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

Path Parameters

string

required

Body

application/json

name

string

Example:

"EU wholesale"

description

string | null

position

integer

Example:

1

starts_at

string<date-time> | null

Pair with ends_at to schedule the list: activating a list whose start is in the future marks it scheduled.

Example:

"2026-06-01T00:00:00Z"

ends_at

string<date-time> | null

Example:

"2026-09-01T00:00:00Z"

match_policy

enum<string>

all: every rule must match. any: one matching rule is enough.

Available options:

all,

any

Example:

"all"

price_adjustment_percentage

string<decimal> | null

Signed: negative discounts off base prices, positive marks up.

Pattern: ^-?\d+(\.\d+)?$

Example:

"-15.0"

adjust_compare_at

boolean

rules

object[]

The complete rule set: rules are matched by id and updated, new ones are built, and rules left out are removed.

Show child attributes

price_adjustment_tiers

object[]

Quantity bands on the list's percentage. The payload is the whole ladder: a band left out is removed.

Show child attributes

prices

object[]

Per-variant price overrides. Each row upserts, so the variants it names become part of the list. Curating whole products goes through the nested products endpoint instead.

Show child attributes

Response

200 - application/json

price list updated with nested rules

string

required

name

string

required

description

string | null

required

status

required

The values listed are the built-in ones; extensions may add more.

Available options:

draft,

active,

inactive,

scheduled

position

number

required

match_policy

enum<string>

required

Available options:

all,

any

adjust_compare_at

boolean

required

starts_at

string | null

required

ends_at

string | null

required

deleted_at

string | null

required

created_at

string

required

updated_at

string

required

price_adjustment_percentage

string | null

required

automatic_pricing

boolean

required

currently_active

boolean

required

products_count

number

required

prices_count

number

required

price_adjustment_tiers

object[]

required

Show child attributes

price_rules

object[]

Show child attributes

API basics

Endpoints

Authorizations

Headers

Path Parameters

Body

Response