List Orders

Query parameters

• q (string, query)

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

• email (string, query)

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

• status (string, query)

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

• shopify_product_id (integer, query)

  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.

• digital_product_id (string, query)

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

• created_at_min (string, query)

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

• created_at_max (string, query)

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

• page (integer, query, default 1)

  Page number for pagination.

• per_page (integer, query, default 25)

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

• sort (string, query, default created_at_desc)

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

Response

• orders (array, required)

  List of order objects.

  Order properties:

  • id (string, required)

    Unique order identifier (UUID).

  • name (string, required)

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

  • email (string, required)

    Customer email address.

  • phone (string | null)

    Customer phone number.

  • financial_status (string | null)

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

  • fulfillment_status (string | null)

    Fulfillment status, e.g. fulfilled, partial.

  • total_price (string | null)

    Total price of the order.

  • currency (string | null)

    ISO 4217 currency code, e.g. USD.

  • created_at (string, required)

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

  • download_count (integer, required)

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

• pagination (object, required)

  Pagination metadata.

  Pagination properties:

  • current_page (integer, required)

    Current page number.

  • per_page (integer, required)

    Number of items per page.

  • total_count (integer, required)

    Total number of orders matching the filters.

  • total_pages (integer, required)

    Total number of pages.

Example request

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();

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()

Example response

{
  "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"
}