Create Demand Override

Beta

POST/v1/operations/demand-overrides

Idempotent with Idempotency-Key header. Learn more

Creates a demand override.

The scope reference is validated against the account's items or product lines, so an override can never silently match nothing. An account-scoped override applies to every planned item and takes no scope reference; it must be a delta, not an absolute value. An absolute value replaces the forecast for the period, delta_units adds to it, and delta_percent scales it; a percent override cannot reduce demand by more than 100%.

Permissions requiredValues:demand_overrides:create

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

include[]optional arrayenumValues:scope

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

scope_typestringenumValues:itemproduct_lineaccount

What the override targets.

scope_ref_idstring

ID of the item or product line the override targets. Omit for an account-wide override, which targets every planned item.

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.

unit_idoptional string

ID of the unit the value is expressed in.

reasonoptional stringenumValues:new_customerlost_accountpromotion

Why the adjustment was made.

noteoptional string

Free-form notes about the adjustment.

effective_atoptional string (date-time)

When the override starts being applied to solves. Defaults to now.

expires_atoptional string (date-time)

When the override stops being applied to solves. Omit for an override with no end.

activeoptional boolean

Whether the override is applied to solves at all. Defaults to true.

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

201

Successful response for Create Demand Override

Create Demand Override

import Augno from '@augno/sdk';

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

const demandOverride = await client.operations.demandOverrides.create({
  adjustment: 'delta_units',
  period_ends_at: '2026-05-10T00:23:00Z',
  period_starts_at: '2026-05-10T00:00:00Z',
  scope_ref_id: 'it_0131e386ac683e8c29a71f6f1f',
  scope_type: 'item',
  value: 5000,
});

console.log(demandOverride.id);

import Augno from '@augno/sdk';

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

const demandOverride = await client.operations.demandOverrides.create({
  adjustment: 'delta_units',
  period_ends_at: '2026-05-10T00:23:00Z',
  period_starts_at: '2026-05-10T00:00:00Z',
  scope_ref_id: 'it_0131e386ac683e8c29a71f6f1f',
  scope_type: 'item',
  value: 5000,
});

console.log(demandOverride.id);

201 example

{
  "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"
}

{
  "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"
}

Create Demand Override

Authorization

Query Parameters

Request Body

Returns

Responses