Recurring Data Exports must be enabled on your account before you can request or retrieve them. Once your account is set up, requesting an export is a short handoff to your CSM (Customer Success Manager), and retrieving the files happens through the API using secure download links.
Before You Begin
- Recurring Data Exports enabled: This is a paid add-on. Contact your CSM to enable it on your account before requesting an export.
- Setup decisions ready: Have your template type, export frequency, data modules, file format, and export type decided before you reach out.
- Data Exports Access permission: The user who will retrieve exports needs Data Exports Access permission. See How to Give Users Access to Recurring Data Exports.
For help understanding Recurring Data Exports and deciding on your format, frequency, modules, and export type, see Overview: Recurring Data Exports in ShipHero.
Table of Contents
- How to Request Recurring Data Exports in ShipHero
- How to Retrieve Recurring Data Exports in ShipHero
- Recurring Data Exports Troubleshooting
- Recurring Data Exports Best Practices
How to Request Recurring Data Exports in ShipHero
- Gather your setup decisions: who will pull the data, template type, frequency, data modules, format, and export type.
- Send that information to your CSM.
- ShipHero provisions your account and enables data export access for the user who will pull the data.
- Once your account is set up, you or your technical team can begin retrieving your exports through the API.
How to Retrieve Recurring Data Exports in ShipHero
ShipHero does not email your data or host it in a portal. You retrieve Recurring Data Exports through the API using secure download links. Retrieving your files uses a small amount of your API credits, since retrieval is an API call. Generating the export itself does not consume API credits.
Important
Download links are temporary and expire about 24 hours after an export runs. If a link expires, re-request the last five days of exports to get fresh links. Once you retrieve a file to your own system, that copy is yours to keep.
Two things determine what data you can retrieve. Your account type sets the scope of data available to you, and your permission level sets whether you can access exports at all. You do not set the scope yourself; it reflects how your account is configured.
Building a custom integration to pull your exports? See Overview: ShipHero API Developer Resources. Want to query your exports with an AI assistant instead? See Overview: ShipHero AI Toolkit.
Recurring Data Exports Troubleshooting
Check the following issues when Recurring Data Exports does not behave as expected.
| Issue | Cause | Resolution |
|---|---|---|
| Permission error | The request fails with "User does not have permissions to access data exports" because the user has not been granted Data Exports Access. | See How to Give Users Access to Recurring Data Exports to grant it. |
| Download link expired | Links expire about 24 hours after an export runs. | Re-request the last five days of exports to get fresh links. |
| Files too large to open | Large exports are meant to be loaded into a database or analytics tool, not opened by hand. | If you chose parquet, use a tool built to read it rather than a spreadsheet. |
| Choosing format/modules | You are not sure which data modules or file format fit your use case. | Your CSM can help you match your choices to how you plan to use your data. |
Recurring Data Exports Best Practices
- Request only the modules you will actually use, so your exports stay efficient.
- Start with one full export to establish a baseline, then use delta exports to stay current.
- Choose parquet if you plan to load your data into a database or analytics tool.
- Retrieve your files promptly, since download links expire in about 24 hours.
- Route your data straight into your own systems rather than storing large files on a single computer.