Data Export API

Pro Feature

All data export endpoints require FluentCart Pro to be installed and activated.

Export orders, customers, subscriptions and licenses as flat CSV records or nested JSON records. Every entity exposes the same two-endpoint shape: a schema endpoint that describes what can be exported, and a batch endpoint that streams it out in cursor-paginated chunks.

Base URL: https://your-site.com/wp-json/fluent-cart/v2

---

Entities and permissions

Entity	Schema	Batch	Permission	Policy
Orders	GET /data-export/orders/schema	POST /data-export/orders/batch	orders/export	OrderPolicy
Customers	GET /data-export/customers/schema	POST /data-export/customers/batch	customers/export	CustomerPolicy
Subscriptions	GET /data-export/subscriptions/schema	POST /data-export/subscriptions/batch	subscriptions/export	OrderPolicy
Licenses	GET /data-export/licenses/schema	POST /data-export/licenses/batch	licenses/export	LicensePolicy

Licenses are module-gated

The two license routes are only registered when the licensing module is active (ModuleSettings::isActive('license')). When the module is off the routes do not exist at all and WordPress returns 404 rest_no_route — you will not get a friendly 409.

---

The two-step flow

1. Call the schema endpoint first. It returns the supported formats, the selectable flat csv_columns, and the selectable nested json_modules. The key values it returns are exactly what the batch endpoint accepts:

{
  "export": {
    "entity": "customers",
    "schema_version": 1,
    "formats": [
      { "value": "csv", "label": "CSV file" },
      { "value": "json", "label": "JSON file" }
    ],
    "csv_columns": [
      { "key": "customer_id", "label": "Customer ID", "default_selected": true },
      { "key": "email", "label": "Email", "default_selected": true }
    ],
    "json_modules": []
  }
}

Unknown keys sent to the batch endpoint are silently dropped, so always source them from the schema rather than hardcoding.

2. Loop the batch endpoint until has_more is false, passing the previous response's cursor each time.

---

Batch request

Field	Type	Required	Description
format	string	No	csv (default) yields flat records keyed by columns; json yields nested records keyed by modules.
scope	string	No	all (default), current_page, selected, or search_results.
ids	array	Conditional	Record IDs. Required when scope is current_page or selected. Deduplicated and truncated to the first 5000.
columns	array	Conditional	Column keys from csv_columns. Required (after filtering) when format is csv. Capped at 100.
modules	array	No	Module keys from json_modules. Capped at 100.
filters	object	No	Allowlisted to filter_type, search, active_view, sort_by, sort_type, advanced_filters, user_tz.
cursor	integer	No	Continuation token. Omit or send 0 for the first batch.
max_records	integer	No	Records to return. Clamped into the 100–1000 range (default: 500).

scope: "all" ignores filters

When scope is all, the filters object is discarded entirely — you get every record. Use search_results if you want the filters honoured.

---

Batch response

{
  "export": {
    "entity": "customers",
    "schema_version": 1,
    "records": [
      {
        "record_id": 1219,
        "customer_id": 1219,
        "first_name": "Alex",
        "last_name": "Morgan",
        "email": "[email protected]",
        "status": "active",
        "purchase_count": 1
      }
    ],
    "total": 1,
    "cursor": 1219,
    "has_more": false,
    "batch": {
      "records": 1,
      "elapsed_ms": 2,
      "estimated_bytes": 671,
      "requested_max": 100,
      "next_max": 100
    }
  }
}

Field	Notes
records	For csv, keys are exactly the selected columns. For json, records are nested per the selected modules.
total	Counted only on the first call (cursor absent or 0). null on every continuation — cache it client-side if you are drawing a progress bar.
cursor	Pass back as cursor on the next call. null on the first page.
has_more	Keep looping until this is false.
batch.next_max	Server-suggested max_records for the next call, adapted to observed record size and elapsed time.

---

Self-throttling

These endpoints are budget-bounded, not fixed-size. A batch returns as many records as fit inside a runtime budget and a response-size budget, then stops early — so a response with fewer records than max_records does not mean the export is finished. Only has_more tells you that.

Honour batch.next_max rather than pinning max_records to a constant. It is the server telling you what it can sustain, and following it is what keeps you clear of 413.

---

Errors

Status	Meaning
403	The user lacks the entity's export permission.
409	The module backing the entity is not active.
413	A single record exceeded the response size budget. Lower max_records, or reduce the selected columns/modules.
422	Invalid format or scope; scope of current_page/selected with no ids; or format: "csv" with no valid columns remaining after filtering.