Skip to main content

echoDeleteData

Permanently deletes ECHO data by explicit IDs or list filters. ID deletion returns SUCCESS and deletedCount immediately. Filtered deletion returns PROCESSING and a processId to track completion and the deleted count.

Business Rules​

  • Select exactly one of demand, shipments, or inventory, then exactly one of ids or filter.
  • IDs must contain 1 to 50 records; every record must belong to the company and be deletable.
  • Filters use the existing list filters and delete across all pages in the background.
  • Only manual and adjustment records in the current company can be deleted.
  • Automatic records and inventory changes are never deleted.
  • An empty filter matches all manual and adjustment records in that dataset.
  • For filtered deletion, records created or changed after the request are excluded.
  • Requires the ECHO entitlement.

Error Scenarios​

  • Missing, null, multiple, or unsupported dataset or record selections are rejected.
  • Explicit IDs containing missing, foreign-company, or automatic records are rejected as a whole.
  • Invalid filters, reversed dates, missing login, or company context are rejected.
  • Missing ECHO deletion permission is rejected before scheduling.
  • No matching records completes successfully with a deleted count of zero.

Permissions Required​

  • echo:delete_data
echoDeleteData(
  input: EchoDeleteDataInput!
): EchoDeleteDataResult!

Arguments​

echoDeleteData.input ● EchoDeleteDataInput! non-null input common​

Parameters for EchoDeleteData

Type​

EchoDeleteDataResult object common​

The result of immediate deletion or a queued filtered deletion.