Get downloads for an order

GET/orders/{id}/downloads

Costs 1 rate-limit point · Rate limits

Retrieve a flat list of all downloadable files for an order. Each item includes pre-computed boolean flags indicating whether the download has expired, the download limit has been reached, access has been revoked, or the file is part of a preorder that hasn't been released yet.

The downloadable field is a master flag: it is true only when all conditions are met (not expired, limit not reached, access not revoked, preorder released).

When downloadable is true, the download_url field contains a signed URL (for internal files) or the external URL. When downloadable is false, download_url is null.

If PDF watermarking is enabled for the shop, calling this endpoint also starts watermark generation for eligible PDFs that do not have it yet. Watermarking is asynchronous: entries with watermark_status of processing have a null download_url and should be polled until the status becomes ready, at which point download_url points at the watermarked copy of the file.

Path parameters

idstringRequired
The order ID

Headers

X-Auth-TokenstringRequired
API key for authentication

Returns

order_idstring
Example: 3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f
order_namestring
Example: #1001
downloadsarray of objects
Show 20 child attributesHide child attributes
- idstring
  Unique identifier for this download entry
- product_namestring
  Name of the product this file belongs to
- file_namestring
  Name of the file
- file_typestring
  MIME type of the file
- file_size_bytesinteger
  File size in bytes (0 for external links and licence keys)
- download_urlstring, nullable
  Signed download URL (for internal files) or external URL. When the file is watermarked and watermark_status is ready, this points at the watermarked copy. null when downloadable is false or while watermark_status is processing.
- is_watermarkedboolean
  Whether this file is personalised with the buyer's details by the shop's PDF watermarking settings
- watermark_statusstring
  not_applicable when the file is not watermarked, processing while the watermarked copy is being generated (download_url is null), and ready once download_url serves the watermarked copy.
  
  One of not_applicableprocessingready
- download_countinteger
  Number of times this file has been downloaded for this order
- download_limitinteger, nullable
  Maximum number of downloads allowed per file. null means unlimited.
- download_limit_reachedboolean
  Whether the download limit has been reached
- expires_atstring, nullable
  When the download expires. null means no expiration date is set.
- download_expiredboolean
  Whether the download has expired based on the store's download limit days setting
- access_revokedboolean
  Whether access to this file has been revoked (e.g. due to refund or cancellation)
- is_preorderboolean
  Whether this file belongs to a preorder product
- preorder_available_atstring, nullable
  When the preorder content becomes available. null if not a preorder.
- preorder_releasedboolean
  Whether the preorder has been released (always true for non-preorder items)
- is_licence_keyboolean
  Whether this download is a licence key rather than a file
- licence_keystring, nullable
  The licence key value if this is a licence key type and one has been assigned. null otherwise.
- downloadableboolean
  Master flag indicating whether the file can be downloaded right now. true only when: not expired, download limit not reached, access not revoked, and preorder released (if applicable).

Errors

401

Authentication failed

404

Resource not found

429

Rate limit exceeded

GET/orders/{id}/downloads

curl "https://app.filemonk.io/api/v1/external/orders/{id}/downloads" \
  -H "X-Auth-Token: $FILEMONK_API_KEY"

const res = await fetch("https://app.filemonk.io/api/v1/external/orders/{id}/downloads", {
  headers: {
    "X-Auth-Token": process.env.FILEMONK_API_KEY,
  },
});
const data = await res.json();

import os
import requests

res = requests.get(
    "https://app.filemonk.io/api/v1/external/orders/{id}/downloads",
    headers={"X-Auth-Token": os.environ["FILEMONK_API_KEY"]},
)
data = res.json()

require "net/http"
require "json"

uri = URI("https://app.filemonk.io/api/v1/external/orders/{id}/downloads")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["FILEMONK_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)

Response

{
  "order_id": "3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f",
  "order_name": "#1001",
  "downloads": [
    {
      "id": "3e84eb8d-e1d9-4e92-a4b2-a419c7f1122f",
      "product_name": "Digital Art Pack",
      "file_name": "artwork-collection.zip",
      "file_type": "application/zip",
      "file_size_bytes": 52428800,
      "download_url": "https://example.com",
      "is_watermarked": true,
      "watermark_status": "not_applicable",
      "download_count": 2,
      "download_limit": 5,
      "download_limit_reached": true,
      "expires_at": "2026-01-15T09:30:00Z",
      "download_expired": true,
      "access_revoked": true,
      "is_preorder": true,
      "preorder_available_at": "2026-01-15T09:30:00Z",
      "preorder_released": true,
      "is_licence_key": true,
      "licence_key": "string",
      "downloadable": true
    }
  ]
}

{
  "error": "API key is required"
}

{
  "error": "Resource not found"
}