Export Send Plan
GET/api/send-plans/:sendPlan/export
Download a plan as CSV or XLSX: one row per product and network, with velocity, stock positions, need, suggested / override / final quantity, cases, cover before and after the send, the network's own recommendation, exception flags, and the product's source pool (available, protected, sendable, short).
send-plans:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Bearer Personal Access Token with the send-plans:read scope. The token's user also needs permission to view the send planner.
Query parameters:
- format (optional): csv (default) or xlsx.
Plans of up to 1,000 rows download straight away. Larger plans are built in the background: the response is 202 with tracked_job_log_id, queued, rows and format, and the finished file is offered for download from the background job once it completes.
Text cells that a spreadsheet would read as a formula (starting with =, +, -, @) are prefixed with an apostrophe so they open as plain text.
Response: text/csv or .xlsx file download named send-plan-{id}-{timestamp}.{format}, or 202 JSON for a large plan.
Request
Responses
- 200
- 202
- 401
- 403
- 404
- 429
OK
Response Headers
Accepted
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.
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.