Skip to content

Public API Skill

The Public API Skill is for advanced users working from an agentic coding harness. It provides an agent with more advanced capabilities than those of the MCP option.

Use the Skill when you want an agent to:

  • Analyze ShipHero data with custom query logic.
  • Build or modify software that integrates with ShipHero.
  • Know how to use the ShipHero Public API.

The Skill requires a coding agent. It is not meant for Claude Chat or Claude CoWork type of tools. Use the ShipHero MCP on those clients.

Installation

Download the current Skill package:

shiphero-public-api-skill-20260911.zip

SHA-256 checksum:

834f21793320f8c4077670f3553a5060da26438b0528ae502f687101cda6033c

Every release and its checksum are listed on the Public API Skill releases page.

The fastest installation path is to ask your coding agent to install it:

Download the Public API Skill from https://developer.shiphero.com/shiphero-ai-toolkit/public-api-skill/, verify its SHA-256 checksum, and install it

Verify the checksum

Verify the download before you install it. The expected checksum is published next to the archive as a .sha256 file.

  1. Download the package:

    curl -fsSLO https://developer.shiphero.com/public-api-skill-releases/shiphero-public-api-skill-20260911.zip
  2. Print the expected checksum. It must match the value shown above:

    curl -fsSL https://developer.shiphero.com/public-api-skill-releases/shiphero-public-api-skill-20260911.zip.sha256
  3. Print the checksum of the file you downloaded:

    shasum -a 256 shiphero-public-api-skill-20260911.zip

    On Linux, use sha256sum instead of shasum -a 256. On Windows PowerShell, use Get-FileHash shiphero-public-api-skill-20260911.zip -Algorithm SHA256.

  4. Compare the two values. Install the package only if they are identical. If they differ, delete the file and download it again. To compare them automatically, run:

    curl -fsSL https://developer.shiphero.com/public-api-skill-releases/shiphero-public-api-skill-20260911.zip.sha256 | shasum -a 256 -c -

    The command prints shiphero-public-api-skill-20260911.zip: OK when the checksums match.

Manual installation

Once the checksum matches, extract the zip into your agent’s skill folder.

unzip shiphero-public-api-skill-20260911.zip -d ~/.agents/skills/

Common skill folders:

AgentSkill folder
Codex~/.agents/skills/
Claude Code~/.claude/skills/
Cursor.cursor/skills/

Restart your agent if it does not load newly installed skills automatically.

Usage

After installation, you can ask your agent ShipHero questions:

How many orders did I receive today on ShipHero?

For integration work, be explicit about the target language, framework, and workflow:

Use the ShipHero Public API Skill to add a Node.js function that fetches inventory by SKU from the ShipHero GraphQL API.

The Skill includes scripts for OAuth PKCE token setup, token refresh, and token revocation. When your work is done, ask the agent to revoke the token if it no longer needs access.

You can tell the agent to request only the permissions needed for a task or to omit access to protected personal data. See Scopes for the available permissions and prompt examples.

API Credits

Public API Skill requests use a separate AI Toolkit credit pool. They do not reduce the credits available for standard Public API requests.