Skip to content

Download Purchase Order CSV

GET
/purchase_orders/{id}.csv

🚀 Paid plan only

The purchase order document as a CSV attachment, generated synchronously. As with the PDF operation the body is not JSON and the response is a file download, so navigate to it rather than reading it as data.

id
required
integer

Purchase order ID. The .csv suffix is part of the path, not part of the id.

Example
491
x-api-key
string

E.g. 123

Example
123

The same document as a CSV attachment (Content-Disposition: attachment), so it downloads as a file.

string
Content-Disposition
string

REDIRECT to /orders, not an error document: the purchase-orders plan gate answers any non-JSON format with a redirect. A browser navigation follows it, so the seller lands on the orders page with no explanation and the caller learns nothing.

Location
string

A JSON error body ({"error_messages":[...]}) served under this operation’s filename, from the paid-plan-feature check or the manage_purchase_orders permission check. It is NOT a document. Together with the 302 above this is why the JSON representation should be read FIRST and the download only offered once it succeeded.

Purchase order not found (or belongs to another company).