Create Export

Creates a downloadable CSV file containing a list of orders.

The parameters listed in the payload resembles headers in the CSV file. To include a parameter to the file, add it to parameters.fields.

The available filters are all order object attributes. Additionally, any metadata defined in the metadata schema can be downloaded.

Passing an empty JSON will generate a file containing three default fields: id, source_id, and status.

Response schema

Returns the id of the export object and status of the file generation process. The id is used in the Download Export method to generate the url for the downloadable CSV file. The status indicates whether the file has been scheduled for creation.

Click Try It! to start a request and see the response here!