Spree Admin SDK

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

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

// Check where a file is used before deleting it.
const { data: usage } = await client.media.usage('media_UkLWZg9DAJ')

{
  "data": [
    {
      "kind": "media",
      "name": "Product 413397",
      "owner_type": "product",
      "owner_id": "prod_UkLWZg9DAJ",
      "field": "attachment"
    }
  ]
}

Where a file is used

Lists everywhere this file appears: products it is placed on, image fields that picked it, and descriptions embedding it. Reusing a file shares it rather than copying it, so deleting one placement can leave others pointing at the same file — check this first.

Description matches are best-effort: an embedded image is a plain URL with nothing recording it, so treat an empty result as “nothing found”, not proof the file is unused.

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

GET

api

admin

media

{id}

usage

Spree Admin SDK

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

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

// Check where a file is used before deleting it.
const { data: usage } = await client.media.usage('media_UkLWZg9DAJ')

{
  "data": [
    {
      "kind": "media",
      "name": "Product 413397",
      "owner_type": "product",
      "owner_id": "prod_UkLWZg9DAJ",
      "field": "attachment"
    }
  ]
}

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

Bearer token for admin authentication

Path Parameters

string

required

Media ID

Response

200 - application/json

usage found

data

object[]

Show child attributes

⌘I

API basics

Endpoints

Where a file is used

Authorizations

Headers

Path Parameters

Response