Download Order Export

GET {{BASE_HABITAT_URL}}/api/v3/orders/export/{{ORDER_EXPORT_ID}}/download?token={{ORDER_EXPORT_DOWNLOAD_TOKEN}}

Required scope: reports:read

Download the generated orders export file.

When to use

After Get Order Export returns status: "ready", download the file using either:

• the full download_url returned in the status response (recommended), or
• this endpoint with the token query parameter from that URL.

You can also call this endpoint with only your bearer token (no token query param) while logged in as the user who created the export, as long as the export is still ready and not expired.

Authentication

One of:

• Bearer token — same API key used for other Platform API requests, as the export owner.
• token query param — short-lived token from download_url (15 minute TTL). Useful for email links and browser downloads without storing API credentials.

Path parameters

Parameter	Description
exportId	Export UUID from Create Order Export.

Query parameters

Parameter	Required	Description
token	No*	Download token from download_url. Required for unauthenticated browser/email downloads.

Response

Returns the raw file bytes with headers:

• Content-Disposition: attachment; filename=orders-export-{id}.{format}
• Content-Type matching the export format

Errors

• 404 — export not found, not owned by caller, not ready, expired, or invalid token.

Notes

• Prefer the download_url from Get Order Export — it includes a fresh token.
• Export files expire 24 hours after completion.

Examples

cURL

curl --request GET '${BASE_HABITAT_URL}/api/v3/orders/export/${ORDER_EXPORT_ID}/download?token=${ORDER_EXPORT_DOWNLOAD_TOKEN}'

Node.js

const response = await fetch("${BASE_HABITAT_URL}/api/v3/orders/export/${ORDER_EXPORT_ID}/download?token=${ORDER_EXPORT_DOWNLOAD_TOKEN}", {
  "method": "GET",
  "headers": {}
})
const data = await response.json()

Python

import requests

response = requests.request(
    "GET",
    "${BASE_HABITAT_URL}/api/v3/orders/export/${ORDER_EXPORT_ID}/download?token=${ORDER_EXPORT_DOWNLOAD_TOKEN}",
    headers={},
)
response.raise_for_status()