Skip to main content

demandPlanningInventory

Returns a stored demand planning page with global ranking and inventory attention counts.

Business Rules​

  • Demand covers the last 90 complete days in the company time zone.
  • Page reads request a background refresh when the configured interval has elapsed.
  • A null refreshedAt means the first snapshot is pending; stale results remain readable.
  • Demand remains company-wide for building filters.
  • Attention counts precede the selected attention filter and pagination.
  • Missing ECHO records are distinct from recorded zero demand.

Error Scenarios​

  • Invalid page sizes, offsets, filters, or inaccessible brands are rejected.
  • Failed refreshes retain the last complete snapshot and its refresh timestamp.

Permissions Required​

  • An authenticated company context, list_inventory, and echo:read.
  • The demand planning and ECHO entitlements.
demandPlanningInventory(
  attention: DemandPlanningAttentionEnum
  filters: DemandPlanningFiltersInput
  limit: Int = 50
  offset: Int = 0
  sortDirection: SortTypeEnum = DESC
  sortField: DemandPlanningSortEnum = AVERAGE_MONTHLY_UNITS
): DemandPlanningPage!

Arguments​

demandPlanningInventory.attention ● DemandPlanningAttentionEnum enum common​

Optional attention selection applied after card counts.

demandPlanningInventory.filters ● DemandPlanningFiltersInput input common​

Inventory filters; demand is aggregated per SKU across the company.

demandPlanningInventory.limit ● Int scalar common​

Page size, from 1 to 100.

demandPlanningInventory.offset ● Int scalar common​

Nonnegative number of globally sorted matching rows to skip.

demandPlanningInventory.sortDirection ● SortTypeEnum enum common​

Ascending or descending order, missing values last.

demandPlanningInventory.sortField ● DemandPlanningSortEnum enum common​

Global sort field.

Type​

DemandPlanningPage object common​

A bounded inventory page, globally calculated attention counts, and demand window.