List Demand Overrides

Beta

GET/v1/operations/demand-overrides

This endpoint is idempotent. Learn more

Returns a paginated list of demand overrides, most recently created first.

The period filters match on overlap rather than containment, so an override spanning a quarter is returned when querying a single month inside it.

Permissions requiredValues:demand_overrides:read

The role behind your API key or agent must grant every one of these permissions.

cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

scope_types[]optional arrayenumValues:itemproduct_lineaccount

Only return overrides targeting these kinds of resource.

scope_ref_ids[]optional array

Only return overrides targeting these items or product lines.

adjustments[]optional arrayenumValues:absolutedelta_unitsdelta_percent

Only return overrides making these kinds of adjustment.

statuses[]optional arrayenumValues:activeinactive

Only return overrides in these activation states.

period_startoptional string

Only return overrides whose period ends on or after this timestamp, formatted as RFC3339.

period_endoptional string

Only return overrides whose period starts on or before this timestamp, formatted as RFC3339.

include[]optional arrayenumValues:scope

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of demand_override

Resources in this page.

idstring

Demand override ID.

objectstringenumValues:demand_override

Resource type identifier.

scope_typestringenumValues:itemproduct_lineaccount

What kind of resource the override targets. Mirrors scope.type, which is only present when the scope is expanded.

scopeentityExpandablenullable

The item or product line the override targets. Expandable. Null for an account-wide override, which targets everything.

This is a single reference rather than one field per scope because a given override targets exactly one of them; scope.type names which.

idstring

Unique identifier for the entity.

objectstringenumValues:entity

Resource type identifier.

typestringenumValues:accountactorentity

The resource kind that this entity references, as an object-type value (e.g. user, account).

Unlike object — which is always entity — this names the underlying resource the id points to.

namestringnullable

Human-readable display name for the entity (e.g. a user's full name, a sales order number).

handlestringnullable

Secondary human-readable identifier (e.g. email address, username, redacted API key value).

period_starts_atstring (date-time)

First day of the demand period the override applies to.

period_ends_atstring (date-time)

Last day of the demand period the override applies to.

adjustmentstringenumValues:absolutedelta_unitsdelta_percent

How the value adjusts the forecast.

valuenumber

The adjustment, interpreted according to adjustment.

unitunitnullable

The unit the value is expressed in. Expandable.

reasonstringnullableenumValues:new_customerlost_accountpromotion

Why the adjustment was made.

notestringnullable

Free-form notes about the adjustment.

created_byactornullable

The actor that created the override. This may be a user, an API key, or an agent. Expandable.

effective_atstring (date-time)

When the override starts being applied to solves.

expires_atstring (date-time)nullable

When the override stops being applied to solves.

statusstringenumValues:activeinactive

Whether the override is applied to solves at all.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Demand Overrides

List Demand Overrides

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listDemandOverride = await client.operations.demandOverrides.list();

console.log(listDemandOverride.data);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listDemandOverride = await client.operations.demandOverrides.list();

console.log(listDemandOverride.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/demand-overrides?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiZGVvdl8wMTkyYjdkMzhjNGY1YTliMDJkM2UxNmY4OCIsImQiOiJmIn0.YBljzYf0bRC1T20zJ5ISVIrRjcviKHNyxPGoz_z9yrU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "deov_0192b7d38c4f5a9b02d3e16f88",
      "object": "demand_override",
      "scope_type": "item",
      "scope": {
        "id": "it_0131e386ac683e8c29a71f6f1f",
        "object": "entity",
        "type": "item",
        "name": null,
        "handle": null
      },
      "period_starts_at": "2026-05-10T00:00:00Z",
      "period_ends_at": "2026-05-10T00:23:00Z",
      "adjustment": "delta_units",
      "value": 5000,
      "unit": null,
      "reason": "new_customer",
      "note": "Northwind onboarding; first PO expected in September.",
      "created_by": null,
      "effective_at": "2026-05-10T00:00:00Z",
      "expires_at": null,
      "status": "active",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": "/v1/operations/demand-overrides?cursor=eyJjIjoiMjAyNi0wNS0xMFQwMDowMDowMFoiLCJzIjoiZGVvdl8wMTkyYjdkMzhjNGY1YTliMDJkM2UxNmY4OCIsImQiOiJmIn0.YBljzYf0bRC1T20zJ5ISVIrRjcviKHNyxPGoz_z9yrU",
    "previous_page_url": null,
    "has_next_page": true,
    "has_prev_page": false
  },
  "data": [
    {
      "id": "deov_0192b7d38c4f5a9b02d3e16f88",
      "object": "demand_override",
      "scope_type": "item",
      "scope": {
        "id": "it_0131e386ac683e8c29a71f6f1f",
        "object": "entity",
        "type": "item",
        "name": null,
        "handle": null
      },
      "period_starts_at": "2026-05-10T00:00:00Z",
      "period_ends_at": "2026-05-10T00:23:00Z",
      "adjustment": "delta_units",
      "value": 5000,
      "unit": null,
      "reason": "new_customer",
      "note": "Northwind onboarding; first PO expected in September.",
      "created_by": null,
      "effective_at": "2026-05-10T00:00:00Z",
      "expires_at": null,
      "status": "active",
      "created_at": "2026-05-10T00:00:00Z",
      "updated_at": "2026-05-10T00:23:00Z"
    }
  ]
}

List Demand Overrides

Authorization

Query Parameters

Returns

Responses