Retrieve Demand Override

Beta
GET/v1/operations/demand-overrides/{id}

This endpoint is idempotent. Learn more

Retrieves a single demand override by ID.

Permissions requiredValues:demand_overrides:read
The role behind your API key or agent must grant every one of these permissions.
idstring

ID of the demand override.

include[]optional arrayenumValues:scope

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

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 Retrieve Demand Override