Overview
The Filemonk API is a REST API for managing digital products, assets, and orders in your Shopify store. All endpoints return JSON responses and require authentication via theX-Auth-Token header.
Endpoints
Assets
Create, read, update, and delete assets — uploaded files, external URLs, and licence keys delivered to customers.List assets
GET /assets — Search and paginate through your store’s assets.Get asset
GET /assets/{id} — Retrieve a single asset by ID.Create asset
POST /assets — Create an internal (uploaded), external URL, or licence key asset.Upload asset
POST /assets — Upload a file directly to Filemonk storage in one call.Update asset
PATCH /assets/{id} — Update an existing asset.Delete asset
DELETE /assets/{id} — Remove an asset.Digital Products
Link assets to Shopify products and variants to create digital products.List digital products
GET /digital_products — List and filter digital products.Get digital product
GET /digital_products/{id} — Retrieve a single digital product by ID.Create digital product
POST /digital_products — Link assets to a Shopify product.Update digital product
PATCH /digital_products/{id} — Update an existing digital product.Delete digital product
DELETE /digital_products/{id} — Remove a digital product.Orders
Access orders, manage attached assets, and trigger customer notifications.List orders
GET /orders — Search, filter, and paginate through your store’s orders.Get order
GET /orders/{id} — Retrieve a single order by ID.Get order downloads
GET /orders/{id}/downloads — Get all download files for an order with pre-computed status flags.Attach assets to order
POST /orders/{id}/attach_assets — Attach files to an order. BetaDetach assets from order
DELETE /orders/{id}/detach_assets — Remove custom-attached files. BetaNotify order
POST /orders/{id}/notify — Send the download notification email. BetaUpload file to order
End-to-end guide: upload → attach → notify. Beta
Common response codes
| Status Code | Description |
|---|---|
200 OK | Request succeeded |
201 Created | Resource created successfully |
401 Unauthorized | Missing or invalid API key |
404 Not Found | Resource does not exist |
422 Unprocessable Entity | Validation failed — check the errors array in the response |
429 Too Many Requests | Rate limit exceeded — check the Retry-After header |