Create a product digital asset

Spree Admin SDK

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

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

// `signed_id` comes from `files.upload()` with `visibility: 'private'`.
const digitalAsset = await client.products.digitalAssets.create('prod_86Rf07xd4z', {
  signed_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MTIzfX0=--abc123',
  authorized_clicks: 5,
  authorized_days: 30,
})

{
  "id": "dig_gbHJdmfrXB",
  "variant_id": "variant_UkLWZg9DAJ",
  "filename": "manual.pdf",
  "content_type": "image/jpeg",
  "authorized_clicks": 5,
  "authorized_days": 30,
  "byte_size": 18090,
  "created_at": "2026-01-15T12:00:00.000Z",
  "updated_at": "2026-01-15T12:00:00.000Z",
  "provider_type": null,
  "provider_name": "File",
  "download_url": "http://www.example.com/rails/active_storage/disk/eyJfcmFpbHMiOnsiZGF0YSI6eyJrZXkiOiJhOXR0cGNpbmxxbThvbmtlNHM1NmI2Y3gxMWVzIiwiZGlzcG9zaXRpb24iOiJhdHRhY2htZW50OyBmaWxlbmFtZT1cIm1hbnVhbC5wZGZcIjsgZmlsZW5hbWUqPVVURi04JydtYW51YWwucGRmIiwiY29udGVudF90eXBlIjoiaW1hZ2UvanBlZyIsInNlcnZpY2VfbmFtZSI6InRlc3QifSwiZXhwIjoiMjAyNi0wMS0xNVQxMjowNTowMC4wMDBaIiwicHVyIjoiYmxvYl9rZXkifX0=--0df5c2167c42cdda6a5f6639d3ddc1b4473c5a81/manual.pdf",
  "effective_authorized_clicks": 5,
  "effective_authorized_days": 30,
  "provider_settings": {}
}

POST

api

admin

products

{product_id}

digital_assets

Spree Admin SDK

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

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

// `signed_id` comes from `files.upload()` with `visibility: 'private'`.
const digitalAsset = await client.products.digitalAssets.create('prod_86Rf07xd4z', {
  signed_id: 'eyJfcmFpbHMiOnsiZGF0YSI6MTIzfX0=--abc123',
  authorized_clicks: 5,
  authorized_days: 30,
})

{
  "id": "dig_gbHJdmfrXB",
  "variant_id": "variant_UkLWZg9DAJ",
  "filename": "manual.pdf",
  "content_type": "image/jpeg",
  "authorized_clicks": 5,
  "authorized_days": 30,
  "byte_size": 18090,
  "created_at": "2026-01-15T12:00:00.000Z",
  "updated_at": "2026-01-15T12:00:00.000Z",
  "provider_type": null,
  "provider_name": "File",
  "download_url": "http://www.example.com/rails/active_storage/disk/eyJfcmFpbHMiOnsiZGF0YSI6eyJrZXkiOiJhOXR0cGNpbmxxbThvbmtlNHM1NmI2Y3gxMWVzIiwiZGlzcG9zaXRpb24iOiJhdHRhY2htZW50OyBmaWxlbmFtZT1cIm1hbnVhbC5wZGZcIjsgZmlsZW5hbWUqPVVURi04JydtYW51YWwucGRmIiwiY29udGVudF90eXBlIjoiaW1hZ2UvanBlZyIsInNlcnZpY2VfbmFtZSI6InRlc3QifSwiZXhwIjoiMjAyNi0wMS0xNVQxMjowNTowMC4wMDBaIiwicHVyIjoiYmxvYl9rZXkifX0=--0df5c2167c42cdda6a5f6639d3ddc1b4473c5a81/manual.pdf",
  "effective_authorized_clicks": 5,
  "effective_authorized_days": 30,
  "provider_settings": {}
}

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

product_id

string

required

Product ID

Body

application/json

signed_id

string

A signed_id from files.upload() with visibility: 'private'. On update it replaces the file for everyone who already bought it. A seller's file must be of a content type the marketplace accepts, checked against the file's own signature where it has one.

variant_id

string

On create, defaults to the product's default variant when omitted. On update, omitting it keeps the current variant.

authorized_clicks

integer | null

Null means the store's download settings apply.

authorized_days

integer | null

Null means the store's download settings apply.

provider_type

string

A provider shorthand from the providers endpoint. Omit for an uploaded file; a provider-backed asset sends no signed_id.

provider_settings

object

Values for the provider's settings schema, keyed by field name.

Response

201 - application/json

digital asset created

string

required

variant_id

string | null

required

filename

string | null

required

content_type

string | null

required

authorized_clicks

number | null

required

authorized_days

number | null

required

byte_size

number | null

required

created_at

string

required

updated_at

string

required

provider_type

string | null

required

Digital asset provider; null is an uploaded file. Built-in: file. Extensions may register more.

provider_name

string

required

Digital asset provider name. Built-in: File. Extensions may register more.

download_url

string | null

required

effective_authorized_clicks

number

required

effective_authorized_days

number

required

provider_settings

object

required

⌘I

API basics

Endpoints

Authorizations

Headers

Path Parameters

Body

Response