Skip to content
Need help with our api? Ask in Community

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

Latest Changes

Added dont_allocate_exchange_until_return_release to return_create and return_create_exchange. When set to true, exchange order line items are created in exchange status with quantity_pending_fulfillment: 0, so inventory is not allocated until the exchange is manually released.

Added product to KitComponent, allowing the product and products queries to return product details for kit components.

Added customer_po_number to wholesale order creation, updates, and queries. See the Wholesale Orders flow for examples.

Added the warehouse_profile_create mutation to create a named profile for an existing physical warehouse. Profiles can configure invoice and shipping-label addresses, invoice branding, manual-order prefixes, picking behavior, and available-to-sell behavior. See the Warehouse Profile Create example for requirements, defaults, logo processing, and error handling.

Fixed the sort argument on the inventory_snapshots query, which was previously ignored. Requests now honor the provided value (for example, sort: "-created_at" returns the most recent snapshots first). Requests without an explicit sort keep the existing default ordering by _id (ascending).