Skip to main content

supplyShipmentsGrouped

Retrieves supply shipments in a grouped/hierarchical view.

Returns primary shipments (those with no parent) as the top-level paginated results. Each primary shipment includes its filtered child shipments and total child count.

When filters are applied, the query searches ALL shipments (including children). If a child matches, its root primary shipment is surfaced in the results with the matching children included.

Authentication​

Authentication is required. Unauthenticated requests will fail.

Permissions​

Requires supply:read_shipments permission for the requested brands.

Pagination​

Pagination operates at the primary shipment level using standard Relay cursor-based pagination.

supplyShipmentsGrouped(
  after: String
  before: String
  filters: SupplyShipmentFilterInput
  first: Int
  last: Int
  sortField: SupplyShipmentSortFieldEnum = CREATED_AT
  sortOrder: SortTypeEnum = DESC
): GroupedShipmentConnection!

Arguments​

supplyShipmentsGrouped.after ● String scalar​

Returns the elements in the list that come after the specified cursor.

supplyShipmentsGrouped.before ● String scalar​

Returns the elements in the list that come before the specified cursor.

supplyShipmentsGrouped.filters ● SupplyShipmentFilterInput input​

Filter criteria to narrow down supply shipment results

supplyShipmentsGrouped.first ● Int scalar​

Returns the first _n_ elements from the list.

supplyShipmentsGrouped.last ● Int scalar​

Returns the last _n_ elements from the list.

supplyShipmentsGrouped.sortField ● SupplyShipmentSortFieldEnum enum​

Field to sort supply shipments by (defaults to created_at)

supplyShipmentsGrouped.sortOrder ● SortTypeEnum enum​

Sort direction - ASC for ascending, DESC for descending (defaults to DESC)

Type​

GroupedShipmentConnection object​

The connection type for GroupedShipment.