ShipHero generates Recurring Data Exports automatically for your account, so there is nothing to request. To get your files, turn on data exports access for the user who will retrieve them, then retrieve the files through the Public API using secure download links.
Before You Begin
- Administrator access: Only an administrator can change a user's API access and data exports access.
- Data Exports Access permission: The user who will retrieve exports needs Data Exports Access in addition to API Access. See How to Give Users Access to Recurring Data Exports.
For help understanding Recurring Data Exports, including the schedule, full and delta exports, and data modules, see Overview: Recurring Data Exports in ShipHero.
Table of Contents
- How to Get Access to Recurring Data Exports in ShipHero
- How to Retrieve Recurring Data Exports in ShipHero
- Recurring Data Exports Troubleshooting
- Recurring Data Exports Best Practices
How to Get Access to Recurring Data Exports in ShipHero
- Go to My Account > Users and select the first name of the ShipHero user who will retrieve the exports.
- Under API Access, select Enable API Access, then select Enable Data Exports Access. Review the warning and save.
- Wait for ShipHero to generate your next export. Full exports run once per week and delta exports run four times per day.
- Have your technical team, connected system, or authorized AI agent retrieve the download links through the Public API. See the next section.
For a third-party Developer User, see How to Give Users Access to Recurring Data Exports for the Developer Users steps.
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
Each download link expires after 24 hours for security. If a link expires, a fresh link can be retrieved without recreating the export. 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 | Each link expires after 24 hours for security. | Retrieve a fresh link. You do not need to recreate the export. |
| Files too large to open | Large exports are meant to be loaded into a database or analytics tool, not opened by hand. | ShipHero delivers exports in Parquet format. Use a tool built to read Parquet rather than a spreadsheet. |
Recurring Data Exports Best Practices
- Start with a full export to establish a baseline, then use delta exports to stay current.
- Load your Parquet files into a database or analytics tool built to read them.
- Retrieve your files promptly, since each download link expires after 24 hours.
- Route your data straight into your own systems rather than storing large files on a single computer.