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. The q search term matches the override's note.

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 with these kinds of target.

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.

starts_atoptional string

The start of the window to match against. Only return overrides whose period ends on or after this timestamp, formatted as RFC3339.

ends_atoptional string

The end of the window to match against. 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.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

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 the override targets.

  • item: a single item.
  • product_line: every item sold under one product line.
  • account: every item in the plan, which is how a blanket assumption such as "plan for double demand" is expressed.
scopeentityExpandablenullable

The item or product line the override targets.

An account-wide override has no scope resource, because it targets every planned item rather than one thing.

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.

Overrides are applied month by month, so every calendar month the period touches is adjusted and any time of day is ignored.

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.

  • absolute: replaces the forecast for each month in the period.
  • delta_units: adds the value to each month in the period.
  • delta_percent: scales each month in the period by the value as a percentage.

When several overrides land on the same month they are applied in that order, so a percentage always acts on the already-adjusted number. An adjusted month is never taken below zero.

valuenumber

The amount of the adjustment, interpreted according to adjustment.

A delta_percent value is a number of percent, so -25 plans a quarter less than the forecast.

unitunitnullable

The unit the value is expressed in.

Recorded for context only: the value is applied to the planned demand without unit conversion, so a unit adjustment should be stated in the unit the item is planned in.

reasonstringnullableenumValues:new_customerlost_accountpromotion

Why the adjustment was made.

The reason is carried into each schedule the override changes, so a plan can explain why a month departs from history.

notestringnullable

Free-form notes about the adjustment.

created_byactornullable

The actor that created the override.

May be a user, an API key, or an agent.

effective_atstring (date-time)

When the override starts being applied to newly generated schedules.

expires_atstring (date-time)nullable

When the override stops being applied to newly generated schedules.

An override with no expiry keeps applying until it is deactivated or deleted.

statusstringenumValues:activeinactive

Whether the override is taken into account when a schedule is generated.

An inactive override is skipped whatever its effective window says, which is how a prepared adjustment is parked without losing it.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Demand Overrides