Data export API

Start a CSV or JSON export of any record type through the API. Use it to pull shipments, orders, items and other records into your own systems.

How it works

Start a data export through the API to pull a filtered set of records out of ShipGenius as a file. It suits jobs that would take many pages of search results, like a nightly warehouse feed, a finance reconciliation or a one-off data pull.

An export request makes three choices.

Which records: a record type, such as orders, items or shipments, and a filter in the same language as search.
Which fields: the fields to include, written as a GraphQL selection. Nested fields pull related records into the same file.
What format: JSON by default. Add CSV column mappings to get a CSV as well.

Getting the file

Exports run in the background. Start one, check on it until it's done, and the result carries a link to the JSON file and, if you asked for one, the CSV. Leave out the filter to export every record of that type.

The Exports page of the API reference has an example of each.