Skip to main content

supplyShipmentUpdatesForCompany

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

Authentication Requirements​

Requires authentication and the supply:receive_company_shipment_updates permission for the specified company.

Business Rules​

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

Error Conditions​

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

Arguments​

supplyShipmentUpdatesForCompany.brandId ● ID deprecated scalar common​

DEPRECATED

Use companyId instead. Brand is becoming a product-only attribute.

The Brand ID for which shipment updates will be received (deprecated).

supplyShipmentUpdatesForCompany.companyId ● ID scalar common​

The Company ID for which shipment updates will be received (preferred).

Type​

SupplySubscriptionsPayload object common​