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
Data Exports
Automatic bulk exports of historical ShipHero data. Accessible via the Public API. Paid add-on.
Experimental API
Beta-only GraphQL operations for tester clients
Examples
Check the updated examples of queries and mutations

Latest Changes

2026 June 29th: Added the pause_shipping filter to the orders query for 3PL accounts. Use pause_shipping: true to find orders for customers with paused shipping, or pause_shipping: false to find orders where shipping is not paused. The filter can be combined with warehouse_id to evaluate the customer relationship for a specific warehouse.

2026 June 25th:

Expanded the wholesale “packed outside ShipHero” flow:

  • Added wholesale_order_mark_as_packed to transition a wholesale order from packing to packed after the packing layout has been imported. It creates the License Plate Numbers (LPNs) for the imported containers, moves inventory out of the staging bin into them, and seeds SSCC-18 barcodes for trading partners that require GS1 labeling. Optional step.
  • Added wholesale_order_generate_labels to asynchronously generate shipping and GS1/carton labels for a packed wholesale order. Optional step.
  • Added wholesale_order_print_labels to mark a wholesale order’s labels as printed and retrieve the shipping labels PDF. Optional step.
  • wholesale_order_import_packing_layout: CasePack entries no longer accept a quantity field — each CasePack represents exactly one physical shippable unit (one SSCC-18 barcode). To pack multiple cases, send separate single-unit CasePack entries.

2026 June 24th: Added the tote_transfer_to_location mutation to move the current picked contents of a tote into a destination location/bin. The tote and destination location must be accessible to the token and belong to the same warehouse. See the schema reference for input and response fields.

2026 June 18th: Added lots to ShipmentLineItem so shipments can expose multiple shipped lots with quantities.

2026 June 15: Added the ShipHero AI Toolkit, which now includes both the ShipHero MCP and the Public API Skill. The toolkit explains when to use each option and how to connect supported AI clients to read-only ShipHero data.

2026 June 12th: Added the product_delete_image mutation to remove a single image from a product, matched by its src URL. The response includes a removed field indicating whether an image was removed (false when no image matched the given src). A blank src is rejected. 3PL users can target a customer’s product with customer_account_id.

View the full changelog