Skip to main content

supplyShipmentFilterValues

Retrieves recent existing values for a shipment text filter.

Business Rules​

Returns up to 20 distinct values from active shipments in the current company and optionally selected brands, ordered by their most recent shipment. Search matches partial values.

Error Scenarios​

Fails for unauthenticated users, missing company context, or unsupported fields.

Permissions Required​

Requires supply:read_shipments in the current company.

supplyShipmentFilterValues(
  brand: [ID!]
  field: SupplyShipmentFilterFieldEnum!
  search: String
): [AttributeCommonValue!]!

Arguments​

supplyShipmentFilterValues.brand ● [ID!] list scalar common​

Optional brand IDs, matching the shipment list’s explicit brand filter.

supplyShipmentFilterValues.field ● SupplyShipmentFilterFieldEnum! non-null enum shipments​

Shipment field to suggest existing values for.

supplyShipmentFilterValues.search ● String scalar common​

Optional case-insensitive partial value to search for.

Type​

AttributeCommonValue object products​

An existing field value, including how many records carry that value.