Export Planned Orders
GET/api/manufacturing/mrp/runs/:mrpRun/planned-orders/export
Download a run's planned orders as a file, in the same column order and wording the planned-order list uses.
Authorization: requires the mrp.view permission and a token carrying the mrp:read scope (manufacturing:read also satisfies it).
Path param: mrpRun = MRP run id.
Response is a file download, not JSON: text/csv for format=csv, an Excel workbook for format=xlsx. Columns: ID, Product, SKU, Warehouse, Supply Type, State, Released Order, Accepted, Qty, Net Requirement, Due Date, Release Date, Lead Time, Lot Sizing, Source, LLC. Quantity and net requirement are separate columns so the number behind a lot-sized quantity is visible, and enum values are written as their display labels (Make, not make).
The export replays the same filters and sort as GET /api/manufacturing/mrp/runs/{mrpRun}/planned-orders, so what downloads is what the filtered list returns. Every filter that endpoint accepts is accepted here, including the operator forms (filter[quantity.greater_than], filter[due_date.between], filter[state.is_one_of], and the same for supply_type, lot_sizing_rule, warehouse_id, net_requirement, lead_time_days, low_level_code and release_date).
format=csv (the default) streams the file and has no size ceiling; format=xlsx builds the workbook in memory and is refused with 422 Export too large above 1,500,000 cells. Any other value is treated as csv.
mrp:read|manufacturing:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.