Remove products from a catalog

Spree Admin SDK

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

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

const { removed_count } = await client.catalogs.products.delete('cat_UkLWZg9DAJ', [
  'prod_86Rf07xd4z',
])

{
  "removed_count": 1
}

DELETE

api

admin

catalogs

{catalog_id}

products

Spree Admin SDK

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

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

const { removed_count } = await client.catalogs.products.delete('cat_UkLWZg9DAJ', [
  'prod_86Rf07xd4z',
])

{
  "removed_count": 1
}

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

product_ids

string[]

required

Products from other stores, or ones the caller cannot see, are ignored.

Example:

["prod_abc123"]

Response

200 - application/json

products removed

⌘I

API basics

Endpoints

Authorizations

Headers

Path Parameters

Body

Response