Export

Exports entity data to a CSV file. The export accepts the same query and filter options as the Query endpoint, plus an exportOptions object to select which fields to include.

POST /api/{entity}/export
Content-Type: application/json

Request Body

{
  "queryCriteriaList": [
    { "field": "status", "value": "IN_STOCK", "operator": "EQ" }
  ],
  "sort": ["name;asc"],
  "exportOptions": {
    "fields": ["reference", "name", "price", "category.name", "status"]
  }
}

The exportOptions.fields list controls which columns appear in the CSV and in what order. All fields from the Query endpoint filter syntax are accepted here, including queryCriteriaList and sort.

TIP

paginationData is ignored in export requests — the export always streams all matching records.

Field Resolution

Field type	CSV column header	Value
Simple field (price)	price	Field value
Nested field (category.name)	name (last path segment)	Resolved relationship value

Response

200 OK with headers:

Content-Type: text/csv
Content-Disposition: attachment; filename="{entity}.csv"

The response body is a CSV stream. For large datasets, results are streamed without loading everything into memory.

Access Control

Requires the export authority for the entity. See RBAC and Export feature docs.