Skip to main content

supplyShipmentUpdates

Subscribe to real-time updates for a specific shipment. This subscription provides live notifications when the specified shipment is updated.

Authentication Requirements​

Requires authentication and the supply:receive_shipment_updates permission for the brand that owns the shipment.

Business Rules​

  • Shipment must exist and be accessible to the user
  • User must have access to the brand that owns the shipment
  • Updates are delivered in real-time as they occur
  • Includes changes to shipment status, items, tracking info, and other fields

Error Conditions​

  • Shipment not found if the shipment ID doesn't exist or is not accessible
  • Authentication required if not logged in
  • Permission denied if user lacks access to the shipment's brand
supplyShipmentUpdates(
  shipmentId: ID!
): SupplySubscriptionsPayload!

Arguments​

supplyShipmentUpdates.shipmentId ● ID! non-null scalar​

The Shipment ID for which updates will be received.

Type​

SupplySubscriptionsPayload object​