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 for the requested brands.

Brand Filtering​

Results are automatically filtered by brand. If no brand is specified in filters, the current brand from the session context is used. You must have permissions for all brands you request.

Possible Errors​

  • Authentication error if not logged in
  • Permission error if lacking access to requested brands
supplyShipments(
  after: String
  before: String
  filters: SupplyShipmentFilterInput
  first: Int
  last: Int
  sortField: SupplyShipmentSortFieldEnum = CREATED_AT
  sortOrder: SortTypeEnum = DESC
): SupplyShipmentConnection!

Arguments​

supplyShipments.after ● String scalar​

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

supplyShipments.before ● String scalar​

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

supplyShipments.filters ● SupplyShipmentFilterInput input​

Filter criteria to narrow down supply shipment results

supplyShipments.first ● Int scalar​

Returns the first _n_ elements from the list.

supplyShipments.last ● Int scalar​

Returns the last _n_ elements from the list.

supplyShipments.sortField ● SupplyShipmentSortFieldEnum enum​

Field to sort supply shipments by (defaults to created_at)

supplyShipments.sortOrder ● SortTypeEnum enum​

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

Type​

SupplyShipmentConnection object​

The connection type for SupplyShipment.