Skip to main content

echoExportData

Requests a background CSV export of ECHO records for the current company. Use the returned processId to track progress and retrieve the completed download.

Business Rules​

  • Select exactly one of demand, shipments, inventory, or inventoryChanges in export.
  • Supply the selected records list filters inside that selection.
  • Use an empty object for the selection to export without filters, up to the row limit.
  • Demand, shipments, and inventory snapshots use their existing CSV formats.
  • Inventory changes export one row per change, newest first, with identifiers, reason, and warehouse and location balances after the change. Warehouse and location names reflect their current names, including archived records; missing names are blank. Timestamps are UTC with microsecond precision; quantities retain decimal precision.
  • The configured export row limit applies (10,000 rows by default).
  • Requires the ECHO entitlement.

Error Scenarios​

  • Missing, null, multiple, or unsupported export selections: the request is rejected.
  • Missing login or company context: the request is rejected.
  • Filters must be valid for the selected records list.
  • Missing ECHO export permission: the request is rejected.
  • No matching records: the CSV contains headers only.

Permissions Required​

  • echo:export
echoExportData(
  input: EchoExportDataInput!
): AsynchronousActionResponse!

Arguments​

echoExportData.input ● EchoExportDataInput! non-null input common​

Parameters for EchoExportData

Type​

AsynchronousActionResponse object common​

Asynchronous action response type