Data Exports access controls which users can retrieve your account's Recurring Data Exports files through the ShipHero Public API. Grant access only to users who need to download or analyze this data.
Before You Begin
- Recurring Data Exports enabled: Recurring Data Exports must be enabled for your account.
- Administrator access: You need administrator access to change user permissions.
- User type confirmed: Confirm whether the person uses a regular ShipHero user or a third-party Developer User.
For an overview of Recurring Data Exports and setup decisions, see Overview: Recurring Data Exports in ShipHero. For the request and retrieval steps, see How to Request Recurring Data Exports in ShipHero.
Important
Recurring Data Exports may contain sensitive business and personal data. Review the user, account, and data access before granting permission.
Table of Contents
- Give a Regular User Recurring Data Exports Access
- Give a Developer User Recurring Data Exports Access
- Troubleshoot Recurring Data Exports Permissions
Give a Regular User Recurring Data Exports Access
An administrator grants Recurring Data Exports access to a regular ShipHero user from the same API Access section used to grant Public API access. Select Enable API Access first, then Enable Data Exports Access, review the warning, and save. Non-admin users cannot change these permissions.
For the full Users & Roles settings reference, including where to find the API Access section, see How to Create and Manage Users in ShipHero.
Give a Developer User Recurring Data Exports Access
Use the Developer Users settings when an external integration uses a token-based third-party Developer User.
- Go to My Account > Developer Users.
- To create a developer user, select Add Third-Party Developer. To update an existing developer user, select Edit.
- Complete or review the developer user's details.
- Select Enable Data Exports.
- Review the warning, then select OK.
- Select Add Developer or Update Developer.
Developer Users use API tokens and refresh tokens instead of signing in to ShipHero with the regular application login. See How to Obtain API Access and Refresh Tokens.
Troubleshoot Recurring Data Exports Permissions
Check the following settings when a user cannot retrieve Recurring Data Exports.
- Permission denied: Confirm that Data Exports access is enabled for the correct user.
- API access error: Confirm that Enable API Access is also enabled for a regular user.
- Developer User cannot retrieve files: Confirm that Enable Data Exports is enabled on the Developer User and that the integration is using the current token.
- No data is returned: Confirm that Recurring Data Exports is enabled for the account and that the requested tables are available for the account type.