# GraphQL API

**URL:** https://community.shiphero.com/c/feedback-on-api/6.md

[Latest](https://community.shiphero.com/latest.md) · [Categories](https://community.shiphero.com/categories.md)

---

## [New account ID field in your Community profile](https://community.shiphero.com/t/new-account-id-field-in-your-community-profile/3734)

<div class="topic-metadata">

**Author:** [@jjconti](https://community.shiphero.com/u/jjconti)\
**Replies:** 0\
**Last updated:** [July 1, 2026, 11:07am UTC](https://community.shiphero.com/t/new-account-id-field-in-your-community-profile/3734 "2026-07-01T11:07:50Z")

</div>

We’ve added a new field to your Community profile where you can enter your ShipHero account ID. This will help ShipHero agents provide more accurate replies in the forum.

---

## [Query Optimization Strategy](https://community.shiphero.com/t/query-optimization-strategy/99)

<div class="topic-metadata">

**Author:** [@yosef](https://community.shiphero.com/u/yosef)\
**Replies:** 0\
**Last updated:** [August 27, 2019, 6:34pm UTC](https://community.shiphero.com/t/query-optimization-strategy/99 "2019-08-27T18:34:15Z")

</div>

A frequent question we get is how to optimize a query when a simple query to get orders has a cost of over 10,000. The reason for that is the lack of a limit which causes the cost analyzer to default to 100. So a query …

---

## [About the GraphQL API category](https://community.shiphero.com/t/about-the-graphql-api-category/18)

<div class="topic-metadata">

**Author:** [@sh-dev](https://community.shiphero.com/u/sh-dev)\
**Replies:** 2\
**Last updated:** [February 17, 2020, 11:08pm UTC](https://community.shiphero.com/t/about-the-graphql-api-category/18 "2020-02-17T23:08:27Z")

</div>

Found any bugs? Need help making a particular call? This is your place

---

## [Inventory\_sync batch stuck in "processing"](https://community.shiphero.com/t/inventory-sync-batch-stuck-in-processing/3785)

<div class="topic-metadata">

**Author:** [@kevchcm](https://community.shiphero.com/u/kevchcm)\
**Replies:** 0\
**Last updated:** [September 28, 2026, 4:07pm UTC](https://community.shiphero.com/t/inventory-sync-batch-stuck-in-processing/3785 "2026-09-28T16:07:55Z")

</div>

We’re hitting the same inventory\_sync “stuck in processing”. We’re a 3PL building an automated pipeline that needs to push absolute (replace-style) inventory quantities from an external vendor system into ShipHero on a …

---

## [Error: 401 Client Error: Unauthorized for url: https://shipping-api.prd2.shiphero.com/graphql](https://community.shiphero.com/t/error-401-client-error-unauthorized-for-url-https-shipping-api-prd2-shiphero-com-graphql/3782)

<div class="topic-metadata">

**Author:** [@aevans](https://community.shiphero.com/u/aevans)\
**Replies:** 1\
**Last updated:** [September 23, 2026, 8:12pm UTC](https://community.shiphero.com/t/error-401-client-error-unauthorized-for-url-https-shipping-api-prd2-shiphero-com-graphql/3782 "2026-09-23T20:12:41Z")

</div>

I keep getting this Error : Error: 401 Client Error: Unauthorized for url: https://shipping-api.prd2.shiphero.com/graphql . No idea how to fix it. Please help!

---

## [ShipHero Sandbox GraphQL API Access](https://community.shiphero.com/t/shiphero-sandbox-graphql-api-access/3778)

<div class="topic-metadata">

**Author:** [@knntmandabon77](https://community.shiphero.com/u/knntmandabon77)\
**Replies:** 6\
**Last updated:** [September 21, 2026, 4:01pm UTC](https://community.shiphero.com/t/shiphero-sandbox-graphql-api-access/3778 "2026-09-21T16:01:20Z")

</div>

Hi, I’m currently working with the ShipHero sandbox and was able to authenticate successfully and receive both an access token and refresh token. However, when I use the access token to make a GraphQL request, I’m gett…

---

## [\[BUG?\] Creating return with self return label](https://community.shiphero.com/t/bug-creating-return-with-self-return-label/3726)

<div class="topic-metadata">

**Author:** [@ocastx](https://community.shiphero.com/u/ocastx)\
**Replies:** 5\
**Last updated:** [September 11, 2026, 4:04pm UTC](https://community.shiphero.com/t/bug-creating-return-with-self-return-label/3726 "2026-09-11T16:04:37Z")

</div>

Hi, we’ve been using the GraphQL API to create returns. At the moment our customers are going through customer service to register a return, for which they create the return manually and select the Label Type “Self Retu…

---

## [Shipment\_create mutation issue with line\_item\_ids , line\_items fields](https://community.shiphero.com/t/shipment-create-mutation-issue-with-line-item-ids-line-items-fields/3773)

<div class="topic-metadata">

**Author:** [@kevchcm](https://community.shiphero.com/u/kevchcm)\
**Replies:** 1\
**Last updated:** [September 10, 2026, 4:42pm UTC](https://community.shiphero.com/t/shipment-create-mutation-issue-with-line-item-ids-line-items-fields/3773 "2026-09-10T16:42:49Z")

</div>

I’m having an issue creating a shipment. I’m getting the following errors: { "errors": \[ { "message": "Field 'CreateShipmentInput.line\_items' of required type '\[CreateShipmentLineItemInput\]!' was not provid…

---

## [Clarification on Tracking Status Updates via Webhook or GraphQL API](https://community.shiphero.com/t/clarification-on-tracking-status-updates-via-webhook-or-graphql-api/3771)

<div class="topic-metadata">

**Author:** [@fnsusa](https://community.shiphero.com/u/fnsusa)\
**Replies:** 1\
**Last updated:** [September 9, 2026, 7:53pm UTC](https://community.shiphero.com/t/clarification-on-tracking-status-updates-via-webhook-or-graphql-api/3771 "2026-09-09T19:53:47Z")

</div>

We are currently working on synchronizing shipment tracking statuses from ShipHero into our system, and I would like to confirm the recommended approach. Based on the ShipHero Developer documentation and Community discu…

---

## [Return kit conponents via API](https://community.shiphero.com/t/return-kit-conponents-via-api/3700)

<div class="topic-metadata">

**Author:** [@mendyshipfrankly](https://community.shiphero.com/u/mendyshipfrankly)\
**Replies:** 6\
**Last updated:** [September 3, 2026, 7:49pm UTC](https://community.shiphero.com/t/return-kit-conponents-via-api/3700 "2026-09-03T19:49:46Z")

</div>

Can I create a return on a regular kit sku but only for one of the components via API?

---

## [Product\_create weight error — "weight\_in\_oz must be between 0 and 9999.9999"](https://community.shiphero.com/t/product-create-weight-error-weight-in-oz-must-be-between-0-and-9999-9999/3768)

<div class="topic-metadata">

**Author:** [@acetinamac](https://community.shiphero.com/u/acetinamac)\
**Replies:** 1\
**Last updated:** [August 27, 2026, 8:22pm UTC](https://community.shiphero.com/t/product-create-weight-error-weight-in-oz-must-be-between-0-and-9999-9999/3768 "2026-08-27T20:22:47Z")

</div>

Hi ShipHero team, We’re getting this error on product\_create for one of our child accounts (3PL, using customer\_account\_id): weight\_in\_oz must be between 0 and 9999.9999 with at most 4 decimal places We sent dimension…

---

## [Adding Tracking Number to Existing Return](https://community.shiphero.com/t/adding-tracking-number-to-existing-return/3764)

<div class="topic-metadata">

**Author:** [@airalingat](https://community.shiphero.com/u/airalingat)\
**Replies:** 1\
**Last updated:** [August 21, 2026, 8:49pm UTC](https://community.shiphero.com/t/adding-tracking-number-to-existing-return/3764 "2026-08-21T20:49:41Z")

</div>

Hi ShipHero Support, We’re integrating ShipHero’s Returns API into our returns portal and have a question about adding a customer-submitted tracking number to an existing return. Our flow is: We create a return via r…

---

## [Is there a way to trigger an inventory sync to a WooCommerce store?](https://community.shiphero.com/t/is-there-a-way-to-trigger-an-inventory-sync-to-a-woocommerce-store/3757)

<div class="topic-metadata">

**Author:** [@shaun](https://community.shiphero.com/u/shaun)\
**Replies:** 3\
**Last updated:** [August 13, 2026, 9:09pm UTC](https://community.shiphero.com/t/is-there-a-way-to-trigger-an-inventory-sync-to-a-woocommerce-store/3757 "2026-08-13T21:09:45Z")

</div>

We are setup with the WooCommerce connector which automatically syncs inventory values from ShipHero to WooCommerce, it works well overall but we have had a couple instances where for whatever (unknown) reason our WooCom…

---

## [Required ship date returning error](https://community.shiphero.com/t/required-ship-date-returning-error/3761)

<div class="topic-metadata">

**Author:** [@lflaerty](https://community.shiphero.com/u/lflaerty)\
**Replies:** 1\
**Last updated:** [August 12, 2026, 7:04pm UTC](https://community.shiphero.com/t/required-ship-date-returning-error/3761 "2026-08-12T19:04:41Z")

</div>

Hi folks, I’m trying to set up a dashboard that will show specific orders that need to be fulfilled within the next week. When I passed required\_ship\_date\_from / required\_ship\_date\_to as filter arguments to the orders q…

---

## [How to return 2 most recent inventory snapshots?](https://community.shiphero.com/t/how-to-return-2-most-recent-inventory-snapshots/3753)

<div class="topic-metadata">

**Author:** [@jeremyw](https://community.shiphero.com/u/jeremyw)\
**Replies:** 3\
**Last updated:** [August 3, 2026, 10:00am UTC](https://community.shiphero.com/t/how-to-return-2-most-recent-inventory-snapshots/3753 "2026-08-03T10:00:07Z")

</div>

Hello! I’m trying to query the last 2 most recent inventory snapshots via the API, but no matter what I’ve tried, I always gets results that are years old, either from 2020 or 2021. We’re definitely running one at leas…

---

## [SSCC data on order confirmation payload](https://community.shiphero.com/t/sscc-data-on-order-confirmation-payload/3754)

<div class="topic-metadata">

**Author:** [@ma.c7](https://community.shiphero.com/u/ma.c7)\
**Replies:** 1\
**Last updated:** [July 30, 2026, 6:01pm UTC](https://community.shiphero.com/t/sscc-data-on-order-confirmation-payload/3754 "2026-07-30T18:01:27Z")

</div>

Hello fellow Shiphero users, I am trying to figure out how I can capture SSCC numbers generated through Shiphero for the dispatch of a B2B/Retailer/EDI order. Does anyone has any sample payload that goes through the reg…

---

## [Shipments Created via API Not Showing in Shipments Report](https://community.shiphero.com/t/shipments-created-via-api-not-showing-in-shipments-report/3749)

<div class="topic-metadata">

**Author:** [@kevchcm](https://community.shiphero.com/u/kevchcm)\
**Replies:** 4\
**Last updated:** [July 22, 2026, 8:49pm UTC](https://community.shiphero.com/t/shipments-created-via-api-not-showing-in-shipments-report/3749 "2026-07-22T20:49:04Z")

</div>

I have a custom system that creates UPS shipments for orders, but they aren’t showing up in the Shipments Report. This is causing issues for our accounting department, as they rely on that report to track shipping expens…

---

## [Product Case Barcodes Endpoint?](https://community.shiphero.com/t/product-case-barcodes-endpoint/2148)

<div class="topic-metadata">

**Author:** [@fairweather](https://community.shiphero.com/u/fairweather)\
**Replies:** 4\
**Last updated:** [July 21, 2026, 7:19pm UTC](https://community.shiphero.com/t/product-case-barcodes-endpoint/2148 "2026-07-21T19:19:08Z")

</div>

There is a feature in product management to assign alternative barcodes using the Product Case Barcodes. I can’t find anything in the API that allows me to add these. Am I missing something or not looking in the right pl…

---

## [Fetch tote history and purchase order in order api](https://community.shiphero.com/t/fetch-tote-history-and-purchase-order-in-order-api/3737)

<div class="topic-metadata">

**Author:** [@Jaypalsinh](https://community.shiphero.com/u/Jaypalsinh)\
**Replies:** 8\
**Last updated:** [July 13, 2026, 3:35pm UTC](https://community.shiphero.com/t/fetch-tote-history-and-purchase-order-in-order-api/3737 "2026-07-13T15:35:09Z")

</div>

Hello, I hope you are doing well. I am currently using the GraphQL API to fetch order data. I have a question regarding fetching tote history and purchase order data for a particular order. I cannot find these details…

---

## [How to specify third\_party\_shipper on order\_create](https://community.shiphero.com/t/how-to-specify-third-party-shipper-on-order-create/2800)

<div class="topic-metadata">

**Author:** [@randycox](https://community.shiphero.com/u/randycox)\
**Replies:** 9\
**Last updated:** [July 8, 2026, 12:35pm UTC](https://community.shiphero.com/t/how-to-specify-third-party-shipper-on-order-create/2800 "2026-07-08T12:35:59Z")

</div>

We need to be able to create an order via the GraphQL API (order\_create mutation), but I’m not seeing a way to specify the third\_party\_shipper on create. Can this be done via the api? I was assuming I’d be able to pass…

---

## [Request for Tote History Data Access for ShipHero Orders](https://community.shiphero.com/t/request-for-tote-history-data-access-for-shiphero-orders/3740)

<div class="topic-metadata">

**Author:** [@rickto.123](https://community.shiphero.com/u/rickto.123)\
**Replies:** 1\
**Last updated:** [July 3, 2026, 6:53pm UTC](https://community.shiphero.com/t/request-for-tote-history-data-access-for-shiphero-orders/3740 "2026-07-03T18:53:23Z")

</div>

We are developing a private app to display ShipHero order data and order history. For this, we require the tote\_history data for tote\_id : VG90ZTozNDM4NzM3OA== I have shared a video showing how we are trying to fetch th…

---

## [504 Gateway Time-out at Pagination (Orders)](https://community.shiphero.com/t/504-gateway-time-out-at-pagination-orders/3678)

<div class="topic-metadata">

**Author:** [@davidelek](https://community.shiphero.com/u/davidelek)\
**Replies:** 2\
**Last updated:** [July 2, 2026, 7:16am UTC](https://community.shiphero.com/t/504-gateway-time-out-at-pagination-orders/3678 "2026-07-02T07:16:15Z")

</div>

Hey! We are paginating through the Orders with the GraphQL API, and lots of our requests end up in 504 Gateway Time-out errors. We queried many fields on the Order object, some sub pages (like attachment), etc. But when…

---

## [POs not showing attachments in API response](https://community.shiphero.com/t/pos-not-showing-attachments-in-api-response/3721)

<div class="topic-metadata">

**Author:** [@snowfreaks](https://community.shiphero.com/u/snowfreaks)\
**Replies:** 5\
**Last updated:** [July 1, 2026, 7:02pm UTC](https://community.shiphero.com/t/pos-not-showing-attachments-in-api-response/3721 "2026-07-01T19:02:31Z")

</div>

Hi there, we’re pulling purchase order data via your Public GraphQL API and warehouse-uploaded photos are visible in the ShipHero web UI but completely absent from the API response. In the web UI our PO shows 3 attach…

---

## [Empty x-shiphero-hmac-sha256 webhook signature](https://community.shiphero.com/t/empty-x-shiphero-hmac-sha256-webhook-signature/3688)

<div class="topic-metadata">

**Author:** [@sgriffin](https://community.shiphero.com/u/sgriffin)\
**Replies:** 4\
**Last updated:** [July 1, 2026, 6:59pm UTC](https://community.shiphero.com/t/empty-x-shiphero-hmac-sha256-webhook-signature/3688 "2026-07-01T18:59:22Z")

</div>

Hi, I’m hitting the same issue as this thread: Webhook has empty x-shiphero-hmac-sha256 signature . PO Update and other webhooks on the same account sign fine. Tried re-registering under both the 3PL and customer accou…

---

## [How to use pick\_priority?](https://community.shiphero.com/t/how-to-use-pick-priority/3665)

<div class="topic-metadata">

**Author:** [@david](https://community.shiphero.com/u/david)\
**Replies:** 1\
**Last updated:** [July 1, 2026, 6:30pm UTC](https://community.shiphero.com/t/how-to-use-pick-priority/3665 "2026-07-01T18:30:37Z")

</div>

Can you give a quick explanation of how Location.pick\_priority should be used? Our interest is in designating a handful of locations as the preferred place for orders to allocate if inventory is available. If that is th…

---

## [Need Shiphrero Order Update WebHooks](https://community.shiphero.com/t/need-shiphrero-order-update-webhooks/3618)

<div class="topic-metadata">

**Author:** [@ajay](https://community.shiphero.com/u/ajay)\
**Replies:** 1\
**Last updated:** [July 1, 2026, 5:25pm UTC](https://community.shiphero.com/t/need-shiphrero-order-update-webhooks/3618 "2026-07-01T17:25:36Z")

</div>

Hi Team, Which webhook should I use to detect new order history logs (order events)? Sample Query: query { orders(customer\_account\_id: “QWNjbnflngsnan==”) { request\_id complexity data(first: 10) { edges { …

---

## [Return the inventory-change id in API mutation responses?](https://community.shiphero.com/t/return-the-inventory-change-id-in-api-mutation-responses/3677)

<div class="topic-metadata">

**Author:** [@david](https://community.shiphero.com/u/david)\
**Replies:** 1\
**Last updated:** [July 1, 2026, 5:15pm UTC](https://community.shiphero.com/t/return-the-inventory-change-id-in-api-mutation-responses/3677 "2026-07-01T17:15:55Z")

</div>

When we call the inventory\_add and inventory\_remove GraphQL mutations, the response currently returns the updated warehouse product but not the id of the inventory change record that the mutation created. However, the in…

---

## [PO# Field Not Available?](https://community.shiphero.com/t/po-field-not-available/3732)

<div class="topic-metadata">

**Author:** [@Alli](https://community.shiphero.com/u/Alli)\
**Replies:** 3\
**Last updated:** [June 30, 2026, 8:46pm UTC](https://community.shiphero.com/t/po-field-not-available/3732 "2026-06-30T20:46:07Z")

</div>

Hello! We use Shopify Plus B2B integrated directly with ShipHero. When our team creates wholesale orders in Shopify, we manually enter our customer’s PO# into Shopify’s PO field. Our challenge is that ShipHero only imp…

---

## [Order Create custom\_barcode in line items displaying incorrect information](https://community.shiphero.com/t/order-create-custom-barcode-in-line-items-displaying-incorrect-information/3710)

<div class="topic-metadata">

**Author:** [@kevchcm](https://community.shiphero.com/u/kevchcm)\
**Replies:** 3\
**Last updated:** [June 30, 2026, 8:40pm UTC](https://community.shiphero.com/t/order-create-custom-barcode-in-line-items-displaying-incorrect-information/3710 "2026-06-30T20:40:12Z")

</div>

I’m trying to use the custom\_barcode field in the line items when creating an order. The field isn’t saving the correct data; it’s saving the data from the barcode field. In this test, I pass “TestCustomBarcode…

---

## [Query products that have dangerous goods, including type of DG](https://community.shiphero.com/t/query-products-that-have-dangerous-goods-including-type-of-dg/3727)

<div class="topic-metadata">

**Author:** [@sashburn](https://community.shiphero.com/u/sashburn)\
**Replies:** 1\
**Last updated:** [June 29, 2026, 5:27pm UTC](https://community.shiphero.com/t/query-products-that-have-dangerous-goods-including-type-of-dg/3727 "2026-06-29T17:27:10Z")

</div>

I’m not finding information in the API documentation that allows me to query products that have been flagged Dangerous Goods and to provide which dangerous goods setting the product(s) have.

[Next page](https://community.shiphero.com/c/feedback-on-api/6.md?page=1)
