Skip to main content
PATCH
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

Path Parameters

id
string
required

Body

application/json
name
string
Example:

"VIP Assortment"

description
string | null

Internal note on what the agreement is, never shown to shoppers.

active
boolean
Example:

true

position
integer
minimum_order_quantity
integer | null

The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.

order_multiple
integer | null

The catalog-wide quantity terms, between a variant's own rule and a per-variant override. Null leaves the field to the variant's own rule.

metadata
object
assignments
object[]

The whole audience. An entry left out is withdrawn; omitting the key leaves the audience alone.

order_minimums
object[]

The whole order-minimum set. A currency left out has its minimum lifted; omitting the key leaves them alone.

price_list
object | null

The price list this catalog prices through, written inline: an object creates the owned list or updates it. Null deletes the list (a soft delete). Omit the key, or send {}, to leave the pricing alone. A catalog with an empty assortment prices without hiding anything; curate or import products to make it restrictive.

Response

200 - application/json

catalog updated

id
string
required
name
string
required
description
string | null
required
active
boolean
required
position
number | null
required
metadata
object | null
required
minimum_order_quantity
number | null
required
order_multiple
number | null
required
created_at
string
required
updated_at
string
required
products_count
number
required
pricing_strategy
string
required
order_minimums
object[]
price_list
object
assignments
object[]