> ## Documentation Index
> Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create a product digital asset

> Attaches a downloadable file to one of the product's variants (the
default variant when `variant_id` is omitted). Upload the file first
through `POST /api/v3/admin/files` with `visibility: 'private'`, then
send its `signed_id` here. A provider-backed asset sends
`provider_type` and `provider_settings` instead of a file.


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



## OpenAPI

````yaml /api-reference/admin.yaml post /api/v3/admin/products/{product_id}/digital_assets
openapi: 3.0.3
info:
  title: Admin API
  contact:
    name: Spree Commerce
    url: https://spreecommerce.org
    email: hello@spreecommerce.org
  description: >
    Spree Admin API v3 - Administrative API for managing products, orders, and
    store settings.


    ## Authentication


    The Admin API requires a secret API key passed in the `x-spree-api-key`
    header.

    Secret API keys can be generated in the Spree admin dashboard.


    ## Response Format


    All responses are JSON. List endpoints return paginated responses with
    `data` and `meta` keys.

    Single resource endpoints return a flat JSON object.


    ## Resource IDs


    Every resource is identified by an opaque string ID (e.g. `prod_86Rf07xd4z`,

    `variant_k5nR8xLq`, `or_UkLWZg9DAJ`). Use these IDs everywhere — URL paths,

    request bodies, and Ransack filters all accept them directly.


    ## Error Handling


    Errors return a consistent format:

    ```json

    {
      "error": {
        "code": "validation_error",
        "message": "Validation failed",
        "details": { "name": ["can't be blank"] }
      }
    }

    ```
  version: v3
servers:
  - url: http://{defaultHost}
    variables:
      defaultHost:
        default: localhost:3000
security: []
tags:
  - name: Authentication
    description: Admin user login, logout, token refresh, and current user profile
  - name: Allowed Origins
    description: CORS allowlist for storefront and admin client origins
  - name: API Keys
    description: Secret and publishable API keys
  - name: Categories
    description: >-
      Hierarchical product categories — tree management, repositioning, and
      product assignments
  - name: Channels
    description: >-
      Sales channels, product publication across channels, and per-channel order
      routing rules
  - name: Custom Fields
    description: >-
      Custom field definitions for products, variants, customers, and other
      resources
  - name: Customer Groups
    description: >-
      Customer groups for segmenting customers (e.g. wholesale, VIP) used by
      pricing and promotions
  - name: Customers
    description: Customer profiles, addresses, credit cards, and store credits
  - name: Email Templates
    description: >-
      Customer email templates, the email layout and shared partials: drafts,
      previews, publishing and history
  - name: Exports
    description: Async CSV exports of admin resources
  - name: Files
    description: Uploading the files that product media, imports, logos and documents use
  - name: Fulfillments
    description: Order fulfillments — shipments, fulfill, cancel, resume, split
  - name: Gift Cards
    description: Gift cards and gift card batches
  - name: Imports
    description: >-
      Async CSV imports of admin resources, with per-row status and failed-row
      retry
  - name: Markets
    description: >-
      Markets — geographic groupings of countries used for pricing, tax, and
      fulfillment rules
  - name: Option Types
    description: >-
      Option types and option values used to build product variants (e.g. Size,
      Color)
  - name: Orders
    description: Orders, order items, applied gift cards, and applied store credits
  - name: Payment Methods
    description: Configured payment providers and their available types
  - name: Payments
    description: Order payments — list, capture, void
  - name: Pricing
    description: >-
      Prices and price lists for currency-, market-, and customer-group-specific
      pricing
  - name: Products
    description: >-
      Products, taxons/categories, product custom field values, and bulk product
      operations
  - name: Policies
    description: The store's legal documents — terms of service, privacy, returns, shipping
  - name: Reasons
    description: >-
      Merchant-owned vocabularies for why a return, claim, refund, cancellation
      or tax exemption happened
  - name: Promotions
    description: Promotions, promotion rules, promotion actions, and coupon codes
  - name: Refunds
    description: Order refunds
  - name: Settings
    description: Store-level settings — store profile, tags, and configuration
  - name: Staff
    description: Admin users, roles, and invitations to the store
  - name: Stock Locations
    description: Warehouses and physical fulfillment locations
  - name: Store Credits
    description: Prepaid customer balances across all customers, and each balance's ledger
  - name: Variants
    description: >-
      Product variants — the individual SKUs (size/color combinations) sold
      under a product
  - name: Webhooks
    description: Webhook endpoints and webhook delivery history
paths:
  /api/v3/admin/products/{product_id}/digital_assets:
    parameters:
      - name: product_id
        in: path
        required: true
        description: Product ID
        schema:
          type: string
    post:
      tags:
        - Products
      summary: Create a product digital asset
      description: |-
        Attaches a downloadable file to one of the product's variants (the
        default variant when `variant_id` is omitted). Upload the file first
        through `POST /api/v3/admin/files` with `visibility: 'private'`, then
        send its `signed_id` here. A provider-backed asset sends
        `provider_type` and `provider_settings` instead of a file.


        **Required scope:** `write_products` (for API-key authentication).
      parameters:
        - name: x-spree-api-key
          in: header
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          required: true
          description: Bearer token for admin authentication
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DigitalAssetCreateParams'
        required: true
      responses:
        '201':
          description: digital asset created
          content:
            application/json:
              example:
                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: {}
              schema:
                $ref: '#/components/schemas/DigitalAsset'
      security:
        - api_key: []
          bearer_auth: []
      x-codeSamples:
        - lang: javascript
          label: Spree Admin SDK
          source: >-
            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,
            })
        - lang: bash
          label: Spree CLI
          source: >-
            spree api post /products/{product_id}/digital_assets -d
            '{"signed_id":"eyJfcmFpbHMiOnsiZGF0YSI6MTIzfX0=--abc123","authorized_clicks":5,"authorized_days":30}'
components:
  schemas:
    DigitalAssetCreateParams:
      type: object
      properties:
        signed_id:
          type: string
          description: >-
            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:
          type: string
          description: >-
            On create, defaults to the product's default variant when omitted.
            On update, omitting it keeps the current variant.
        authorized_clicks:
          type: integer
          description: Null means the store's download settings apply.
          nullable: true
        authorized_days:
          type: integer
          description: Null means the store's download settings apply.
          nullable: true
        provider_type:
          type: string
          description: >-
            A provider shorthand from the providers endpoint. Omit for an
            uploaded file; a provider-backed asset sends no `signed_id`.
        provider_settings:
          type: object
          additionalProperties: true
          description: Values for the provider's settings schema, keyed by field name.
    DigitalAsset:
      type: object
      properties:
        id:
          type: string
        variant_id:
          type: string
          nullable: true
        filename:
          type: string
          nullable: true
        content_type:
          type: string
          nullable: true
        authorized_clicks:
          type: number
          nullable: true
        authorized_days:
          type: number
          nullable: true
        byte_size:
          type: number
          nullable: true
        created_at:
          type: string
        updated_at:
          type: string
        provider_type:
          type: string
          nullable: true
          description: >-
            Digital asset provider; null is an uploaded file. Built-in: file.
            Extensions may register more.
        provider_name:
          type: string
          description: >-
            Digital asset provider name. Built-in: File. Extensions may register
            more.
        download_url:
          type: string
          nullable: true
        effective_authorized_clicks:
          type: number
        effective_authorized_days:
          type: number
        provider_settings:
          type: object
      required:
        - id
        - variant_id
        - filename
        - content_type
        - authorized_clicks
        - authorized_days
        - byte_size
        - created_at
        - updated_at
        - provider_type
        - provider_name
        - download_url
        - effective_authorized_clicks
        - effective_authorized_days
        - provider_settings
      x-typelizer: true
  securitySchemes:
    api_key:
      type: apiKey
      name: x-spree-api-key
      in: header
      description: Secret API key for admin access
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token for admin user authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.