Skip to main content
POST
Spree Admin SDK

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

Body

application/json
name
string
required
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.

price_adjustment_tiers
object[]

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

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.

Response

price list created (server-to-server — rules + prices)

id
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
price_rules
object[]