List Orders

curl -X GET 'https://app.filemonk.io/api/v1/external/orders?status=paid&per_page=10' \
  -H 'X-Auth-Token: fm_api_key_your_key_here'

const response = await fetch(
  'https://app.filemonk.io/api/v1/external/orders?status=paid&per_page=10',
  { headers: { 'X-Auth-Token': 'fm_api_key_your_key_here' } }
);
const data = await response.json();

import requests

response = requests.get(
    'https://app.filemonk.io/api/v1/external/orders',
    headers={'X-Auth-Token': 'fm_api_key_your_key_here'},
    params={'status': 'paid', 'per_page': 10}
)
data = response.json()

{
  "orders": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "#1042",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "financial_status": "paid",
      "fulfillment_status": "fulfilled",
      "total_price": "29.99",
      "currency": "USD",
      "created_at": "2026-03-01T14:30:00Z",
      "download_count": 3
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "#1041",
      "email": "buyer@example.com",
      "phone": null,
      "financial_status": "paid",
      "fulfillment_status": null,
      "total_price": "9.99",
      "currency": "USD",
      "created_at": "2026-02-28T09:15:00Z",
      "download_count": 1
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_count": 142,
    "total_pages": 15
  }
}

{
  "error": "Invalid API key"
}

GET

orders

curl -X GET 'https://app.filemonk.io/api/v1/external/orders?status=paid&per_page=10' \
  -H 'X-Auth-Token: fm_api_key_your_key_here'

const response = await fetch(
  'https://app.filemonk.io/api/v1/external/orders?status=paid&per_page=10',
  { headers: { 'X-Auth-Token': 'fm_api_key_your_key_here' } }
);
const data = await response.json();

import requests

response = requests.get(
    'https://app.filemonk.io/api/v1/external/orders',
    headers={'X-Auth-Token': 'fm_api_key_your_key_here'},
    params={'status': 'paid', 'per_page': 10}
)
data = response.json()

{
  "orders": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "#1042",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "financial_status": "paid",
      "fulfillment_status": "fulfilled",
      "total_price": "29.99",
      "currency": "USD",
      "created_at": "2026-03-01T14:30:00Z",
      "download_count": 3
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "#1041",
      "email": "buyer@example.com",
      "phone": null,
      "financial_status": "paid",
      "fulfillment_status": null,
      "total_price": "9.99",
      "currency": "USD",
      "created_at": "2026-02-28T09:15:00Z",
      "download_count": 1
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_count": 142,
    "total_pages": 15
  }
}

{
  "error": "Invalid API key"
}

Query parameters

string

Search by order name/number or customer email. Performs a partial, case-insensitive match.

string

Filter by customer email address. Partial, case-insensitive match.

string

Filter by financial status. Accepts: paid, pending, partially_paid, partially_refunded, refunded, voided, authorized.

integer

Only return orders that bought a specific Shopify product. Matches the Shopify product behind the order’s digital products — useful for targeting buyers of a single product.

string

Only return orders linked to a specific Filemonk digital product (collection UUID). Can be combined with shopify_product_id.

string

Filter orders created on or after this date. Format: YYYY-MM-DD.

string

Filter orders created on or before this date. Format: YYYY-MM-DD.

integer

default:"1"

Page number for pagination.

integer

default:"25"

Number of orders per page. Minimum: 1, maximum: 250.

string

default:"created_at_desc"

Sort order. Accepts: created_at_desc, created_at_asc, name_asc, name_desc.

Response

array

required

List of order objects.

Show Order properties

string

required

Unique order identifier (UUID).

string

required

Order name/number, e.g. #1001.

string

required

Customer email address.

string | null

Customer phone number.

string | null

Financial status: paid, pending, partially_paid, partially_refunded, refunded, voided, or authorized.

string | null

Fulfillment status, e.g. fulfilled, partial.

string | null

Total price of the order.

string | null

ISO 4217 currency code, e.g. USD.

string

required

ISO 8601 timestamp of when the order was created in Shopify.

integer

required

Total number of file downloads across all files in this order.

object

required

Pagination metadata.

Show Pagination properties

integer

required

Current page number.

integer

required

Number of items per page.

integer

required

Total number of orders matching the filters.

integer

required

Total number of pages.

curl -X GET 'https://app.filemonk.io/api/v1/external/orders?status=paid&per_page=10' \
  -H 'X-Auth-Token: fm_api_key_your_key_here'

const response = await fetch(
  'https://app.filemonk.io/api/v1/external/orders?status=paid&per_page=10',
  { headers: { 'X-Auth-Token': 'fm_api_key_your_key_here' } }
);
const data = await response.json();

import requests

response = requests.get(
    'https://app.filemonk.io/api/v1/external/orders',
    headers={'X-Auth-Token': 'fm_api_key_your_key_here'},
    params={'status': 'paid', 'per_page': 10}
)
data = response.json()

{
  "orders": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "#1042",
      "email": "customer@example.com",
      "phone": "+1234567890",
      "financial_status": "paid",
      "fulfillment_status": "fulfilled",
      "total_price": "29.99",
      "currency": "USD",
      "created_at": "2026-03-01T14:30:00Z",
      "download_count": 3
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "#1041",
      "email": "buyer@example.com",
      "phone": null,
      "financial_status": "paid",
      "fulfillment_status": null,
      "total_price": "9.99",
      "currency": "USD",
      "created_at": "2026-02-28T09:15:00Z",
      "download_count": 1
    }
  ],
  "pagination": {
    "current_page": 1,
    "per_page": 10,
    "total_count": 142,
    "total_pages": 15
  }
}

{
  "error": "Invalid API key"
}

Overview

Assets

Digital Products

Orders

Query parameters

Response

​Query parameters

​Response

Query parameters

Response