Skip to content

Developer Resources

ShipHero GraphQL Public API

ShipHero’s public API provides access to platform data and operations for custom integrations. It is built on GraphQL, allowing clients to request exactly the fields they need for each workflow.

Quick Access

Getting Started
Information on how to access the API and authenticate
Data Exports
Full and delta exports through the Public API. Free for all accounts. Check the migration plan.
Experimental API
Beta-only GraphQL operations for tester clients
Examples
Check the updated examples of queries and mutations

Latest Changes

Added the optional barcodes input to license_plate_numbers_create to create LPNs with caller-supplied barcodes. The number of barcodes must match quantity. Omit barcodes to keep automatic barcode generation.

Added the ids filter to the products query to retrieve specific products by a list of product IDs.

Added must_ship_alone to Product and the product_update mutation input to read and configure whether a product ships separately. When updating, send true to enable, false or null to disable, or omit the field to leave the setting unchanged.

Clarified how the Public API reserves and settles credits, how to compare estimated and final query cost, and how to handle credit and request-rate limits. The Getting Started guide now includes copyable analysis, response, error-handling, and pagination examples.

View the full changelog