Skip to main content

supplyShipmentUpdatesForBrand

Subscribe to real-time updates for all shipments in a specific brand. This subscription provides live notifications when any shipment belonging to the brand is updated.

Authentication Requirements​

Requires authentication and the supply:receive_brand_shipment_updates permission for the specified brand.

Business Rules​

  • User must have access to the brand
  • Updates are delivered in real-time as they occur for all shipments in the brand
  • Includes changes to any shipment status, items, tracking info, and other fields

Error Conditions​

  • Brand not found if the brand ID doesn't exist or is not accessible
  • Authentication required if not logged in
  • Permission denied if user lacks access to the brand
supplyShipmentUpdatesForBrand(
  brandId: ID!
): SupplySubscriptionsPayload!

Arguments​

supplyShipmentUpdatesForBrand.brandId ● ID! non-null scalar​

The Brand ID for which all shipment updates will be received.

Type​

SupplySubscriptionsPayload object​