Bulk-upsert prices

Upserts a batch of prices in a single SQL round trip.

Each row either:

targets an existing price by id, OR
matches on the unique key (variant_id, currency, price_list_id) — updating the existing row if one exists, creating one otherwise.

Model callbacks (e.g. PriceHistory) are bypassed; this is a bulk-write fast path for the admin spreadsheet. The response carries price_count — the number of rows touched.

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

POST

api

admin

prices

bulk_upsert

Spree Admin SDK

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

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

const { price_count } = await client.prices.bulkUpsert({
  prices: [
    {
      variant_id: 'variant_xxx',
      currency: 'USD',
      price_list_id: 'pl_xxx',
      amount: '11.11',
    },
    {
      variant_id: 'variant_yyy',
      currency: 'USD',
      price_list_id: 'pl_xxx',
      amount: '22.22',
    },
  ],
})

spree api post /prices/bulk_upsert -d '{"prices":[{"variant_id":"variant_xxx","currency":"USD","price_list_id":"pl_xxx","amount":"11.11"},{"variant_id":"variant_yyy","currency":"USD","price_list_id":"pl_xxx","amount":"22.22"}]}'

{
  "price_count": 2
}

{
  "error": {
    "code": "missing_prices",
    "message": "prices is required (send an empty array to no-op)."
  }
}

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

prices

object[]

required

Show child attributes

Response

prices upserted

price_count

integer

Update a price

Bulk-delete prices

⌘I

Spree Admin SDK

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

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

const { price_count } = await client.prices.bulkUpsert({
  prices: [
    {
      variant_id: 'variant_xxx',
      currency: 'USD',
      price_list_id: 'pl_xxx',
      amount: '11.11',
    },
    {
      variant_id: 'variant_yyy',
      currency: 'USD',
      price_list_id: 'pl_xxx',
      amount: '22.22',
    },
  ],
})

spree api post /prices/bulk_upsert -d '{"prices":[{"variant_id":"variant_xxx","currency":"USD","price_list_id":"pl_xxx","amount":"11.11"},{"variant_id":"variant_yyy","currency":"USD","price_list_id":"pl_xxx","amount":"22.22"}]}'

{
  "price_count": 2
}

{
  "error": {
    "code": "missing_prices",
    "message": "prices is required (send an empty array to no-op)."
  }
}

API basics

Endpoints

Bulk-upsert prices

Authorizations

Headers

Body

Response