Skip to content

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.

Getting Started
Information on how to access the API and authenticate
GraphQL Primer
Our API is built on GraphQL; here’s a primer on our implementation
Examples
Brief examples of queries and mutations
New! Data Exports
Automatic bulk exports of historical ShipHero data, delivered up to four times per day and accessible via the Public API. Paid add-on.

Latest Changes

2026 May 27th: Added assembly_add_components, assembly_remove_components, assembly_update_components , assembly_clear_components mutations, and added is_assembly support to product_create and product_update. Also added the ability to query assembly product components in product queries.

2026 May 26th: Added support for filtering the plural shipments, locations, and warehouse_products queries by a list of IDs through the ids argument. Added warehouse_relationship and lot_tracking_settings to customer accounts returned by account.data.customers. 3PL users can now request warehouse-specific relationship details, including from_name and pause_shipping, along with each customer’s lot tracking configuration.

2026 May 21st: Added the return_add_attachment mutation to attach files (images, PDFs, documents) to a return by providing a publicly accessible URL. Attachments can be linked to a specific return item via return_item_id for item-level documentation, or to the return as a whole when omitted.

2026 May 14th: Added the staged_inventory field on WholesaleLineItem, returning the staged manifest for a wholesale order — the SKUs, quantities, lots, container types, and bins currently in the staging location, broken down per line item. Use it after wholesale_order_transfer_picks_to_staging to know exactly what’s available to pack and to source the order_line_item_id values for wholesale_order_import_packing_layout. See the staged manifest step in the wholesale orders flow.

2026 May 13th: Added the Transfer Orders flow documenting how to mimic the UI’s transfer order behavior via the Public API by orchestrating order_create and purchase_order_create, including the tag conventions consumed by Multi‑Warehouse Allocation rules.

2026 May 5th: Added updated_from and updated_to optional filters to the returns query.

View the full changelog