Skip to main content

supplyShipmentItems

Retrieves individual shipment items across the current company, including recorded costs.

Business Rules​

  • Filters and pagination apply to items, not shipments.
  • Archived items and shipments are excluded.
  • Legacy items without a product ID match products by SKU within the same company.
  • Parent and child shipment items are separate records. Quantities must not be summed as incoming inventory without accounting for repeated goods across shipment legs.
  • Canceled shipments remain available unless excluded by the status filter.

Error Scenarios​

  • Authentication and company context are required.
  • Access is denied without permission to read supply shipments.

Permissions Required​

  • supply:read_shipments for the current company.
supplyShipmentItems(
  after: String
  before: String
  filters: SupplyShipmentItemFilterInput
  first: Int
  last: Int
  sortField: SupplyShipmentItemSortFieldEnum = CREATED_AT
  sortOrder: SortTypeEnum = DESC
): SupplyShipmentItemConnection!

Arguments​

supplyShipmentItems.after ● String scalar common​

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

supplyShipmentItems.before ● String scalar common​

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

supplyShipmentItems.filters ● SupplyShipmentItemFilterInput input common​

Filters for shipment items, products, and shipment details.

supplyShipmentItems.first ● Int scalar common​

Returns the first _n_ elements from the list.

supplyShipmentItems.last ● Int scalar common​

Returns the last _n_ elements from the list.

supplyShipmentItems.sortField ● SupplyShipmentItemSortFieldEnum enum common​

Field used to order shipment items; ties are ordered by item ID.

supplyShipmentItems.sortOrder ● SortTypeEnum enum common​

Sort direction. Items with missing sort values are placed last.

Type​

SupplyShipmentItemConnection object common​

The connection type for SupplyShipmentItem.