Spree Admin SDK

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

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

// Keyed by product. Both values null clears that product's terms.
await client.catalogs.quantityRules.upsert('cat_UkLWZg9DAJ', {
  terms: {
    prod_86Rf07xd4z: { minimum_order_quantity: 48, order_multiple: 24 },
    prod_9XbR2kQwLm: { minimum_order_quantity: null, order_multiple: null },
  },
})

spree api put /catalogs/{catalog_id}/quantity_rules -d '{"terms":{"prod_86Rf07xd4z":{"minimum_order_quantity":48,"order_multiple":24},"prod_9XbR2kQwLm":{"minimum_order_quantity":null,"order_multiple":null}}}'

Set catalog quantity rules

Writes the given products’ quantity terms in one request, keyed by prefixed product id. The stated pair is written to every variant of the product, which is the grain the database keeps them at. Both fields null clears that product’s terms; a product not yet in the assortment is added, since a term with nothing to apply to is not a reachable state. Products absent from the payload are left alone — an agreement may name terms for thousands of SKUs. Read them back on the assortment rows: GET /catalogs/{id}/products?expand=quantity_rule.

Required scope: write_products (for API-key authentication).

PUT

api

admin

catalogs

{catalog_id}

quantity_rules

Spree Admin SDK

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

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

// Keyed by product. Both values null clears that product's terms.
await client.catalogs.quantityRules.upsert('cat_UkLWZg9DAJ', {
  terms: {
    prod_86Rf07xd4z: { minimum_order_quantity: 48, order_multiple: 24 },
    prod_9XbR2kQwLm: { minimum_order_quantity: null, order_multiple: null },
  },
})

spree api put /catalogs/{catalog_id}/quantity_rules -d '{"terms":{"prod_86Rf07xd4z":{"minimum_order_quantity":48,"order_multiple":24},"prod_9XbR2kQwLm":{"minimum_order_quantity":null,"order_multiple":null}}}'

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

catalog_id

string

required

Body

application/json

terms

object

required

Quantity terms keyed by product: { minimum_order_quantity, order_multiple }, each a whole number or null. A product whose pair is both null has its terms cleared; a product not yet in the assortment is added.

Example:

{
  "prod_abc123": {
    "minimum_order_quantity": 48,
    "order_multiple": 24
  }
}

Response

204

quantity rules set

⌘I

API basics

Endpoints

Set catalog quantity rules

Authorizations

Headers

Path Parameters

Body

Response