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 the full steps to turn on API access for a user, see How to Give a ShipHero User API Access. 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
Recurring Data Exports troubleshooting covers permission errors, API access errors, Developer User problems, missing data, expired download links, and files that are too large to open. Find your issue in the table.
| 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. | Confirm Data Exports Access is turned on for the correct user. See How to Give Users Access to Recurring Data Exports to grant it. |
| API access error | Enable API Access is not turned on for a regular user. Data Exports Access needs API Access. | Turn on Enable API Access for the user, then confirm Enable Data Exports Access is also on. |
| Developer User cannot retrieve files | Enable Data Exports is not turned on for the Developer User, or the integration is not using the current token. | Turn on Enable Data Exports for the Developer User and confirm the integration uses the current token. See How to Give Users Access to Recurring Data Exports for the Developer User steps. |
| No data is returned | The requested tables are not available for the account type. | Confirm the tables you request are available for your account type. |
| 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
Recurring Data Exports work best when you load the files into a tool built to read them and retrieve each link before it expires.
- 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.