Skip to main content

supplyDeleteShipments

Permanently deletes multiple supply shipments.

Authentication​

Requires authentication and the supply:delete_shipment permission.

Behavior​

  • This mutation processes shipments asynchronously. It returns immediately with a processId that can be used to track the operation's progress.
  • Each shipment is permanently deleted from the system.
  • If a shipment fails to delete (e.g., validation error or not found), it will be logged, but the operation continues processing remaining shipments.
  • The mutation processes shipments in batches of 100.
  • **Warning**: This operation is permanent and cannot be undone.

Validation Rules​

  • At least one shipment ID must be provided.
  • Each shipment must exist and belong to the authenticated user's brand.

Possible Errors​

  • No shipment IDs provided - The shipment ID list is empty.
  • Shipment not found - One or more shipments do not exist or do not belong to the brand.
  • Shipment does not exist - The shipment has not been created yet.
supplyDeleteShipments(
  input: DeleteSupplyShipmentsInput!
): AsynchronousActionResponse!

Arguments​

supplyDeleteShipments.input ● DeleteSupplyShipmentsInput! non-null input​

Parameters for DeleteSupplyShipments

Type​

AsynchronousActionResponse object​

Asynchronous action response type