Articles in this section

How to Give a ShipHero User API Access

Updated

The API Access section of a ShipHero user's profile controls whether that user can reach your ShipHero data through the Public API. This includes the ShipHero MCP and the ShipHero Public API Skill, which connect AI assistants to your ShipHero data. API access can be turned on or off at any time.

Before You Begin

  • Required user role permission: Only administrators can change a user's API access.
  • Data Exports: To give a user Data Exports access through the Public API, Data Exports must be enabled on your account.
  • Multi-factor authentication (MFA): When MFA is turned on for a user, that user's API tokens do not work. See How to Manage Multi-Factor Authentication (MFA) for Users.

New ShipHero Users Do Not Have API Access by Default

Users created going forward do not have API access by default. An administrator must select Enable API Access to grant it. Users that existed before this change were opted in automatically to preserve their current permissions, and an administrator can disable access for any of them at any time.

To create a user first, see How to Create and Manage Users in ShipHero. To learn what AI assistants can do with API access, see Overview: ShipHero AI Toolkit.

Table of Contents

ShipHero API Access: Regular User or Developer User

ShipHero offers two kinds of API access. Which one you need depends on what is connecting to your ShipHero data.

  • Regular user: Give a regular user API access to connect an AI assistant through the ShipHero MCP or the ShipHero Public API Skill. Follow the steps in this article.
  • Developer user: When a third-party integration or custom-built app needs its own API tokens, create a developer user on the Developer Users page instead. See How to Obtain API Access and Refresh Tokens.

API tokens only work in the account where they were created, including tokens used by the ShipHero MCP and the Public API Skill. See How to Obtain API Access and Refresh Tokens for details.

How to Enable API Access for a ShipHero User

API access is set on each user's profile from the Users & Roles page.

  1. Go to the Users & Roles page, then create a new user or select the name of the user you want to update.
  2. Go to the API Access section at the bottom of the user's profile.
  3. Select Enable API Access.
  4. Optional: To give the user access to Data Exports through the Public API, select Enable Data Exports Access, then review the warning.
  5. Save the user.

To remove a user's API access, clear Enable API Access and save the user.

ShipHero User API Access Settings

The API Access section holds two settings.

Setting Definition
Enable API Access Allows this user to access the Public API. Clear the checkbox to remove the user's API access at any time. Only administrators can change this setting.
Enable Data Exports Access Gives this user access to Data Exports through the Public API. Requires Enable API Access, and Data Exports must be enabled on your account. See Data Export reporting services.

More Resources

  • ShipHero Public API

    Connect your tools and AI agents directly to ShipHero with the Public API. Build powerful integrations, automate workflows, and tap into real-time data using the AI tools you prefer, with the option for secure, read-only access for AI-driven insights without added risk.

  • ShipHero Academy

    Explore ShipHero Academy for certifications, deep-dive training, and expert-led courses on WMS and fulfillment. Build your expertise and help your team operate at a higher level.

  • Change Log

    Stay up to date with the latest improvements across ShipHero. The Change Log gives you a clear view of new features, enhancements, and fixes as they roll out—so you always know what’s new and what’s better.