Skip to main content

supplyShipments

Retrieves supply shipments with filtering and sorting capabilities.

Authentication​

Authentication is required. Unauthenticated requests will fail.

Permissions​

Requires supply:read_shipments permission.

Company Filtering​

Results are filtered by company. The company context is required via the X-Company-Id header.

Possible Errors​

  • Authentication error if not logged in
  • Company context required error if no company specified
  • Permission error if lacking access
supplyShipments(
  after: String
  before: String
  filters: SupplyShipmentFilterInput
  first: Int
  last: Int
  sortField: SupplyShipmentSortFieldEnum = CREATED_AT
  sortOrder: SortTypeEnum = DESC
): SupplyShipmentConnection!

Arguments​

supplyShipments.after ● String scalar common​

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

supplyShipments.before ● String scalar common​

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

supplyShipments.filters ● SupplyShipmentFilterInput input shipments​

Filter criteria to narrow down supply shipment results

supplyShipments.first ● Int scalar common​

Returns the first _n_ elements from the list.

supplyShipments.last ● Int scalar common​

Returns the last _n_ elements from the list.

supplyShipments.sortField ● SupplyShipmentSortFieldEnum enum shipments​

Field to sort supply shipments by (defaults to created_at)

supplyShipments.sortOrder ● SortTypeEnum enum common​

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

Type​

SupplyShipmentConnection object common​

The connection type for SupplyShipment.